Changeset 166731 in webkit

Timestamp:

Apr 3, 2014 11:06:50 AM (10 years ago)

Author:

andersca@apple.com

Message:

Document WKNavigationAction and WKNavigationResponse
​https://bugs.webkit.org/show_bug.cgi?id=131138

Reviewed by Sam Weinig.

• UIProcess/API/Cocoa/WKFrameInfo.h:
• UIProcess/API/Cocoa/WKNavigationAction.h:
• UIProcess/API/Cocoa/WKNavigationResponse.h:

Location:

trunk/Source/WebKit2

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/API/Cocoa/WKFrameInfo.h (modified) (1 diff)
• UIProcess/API/Cocoa/WKNavigationAction.h (modified) (2 diffs)
• UIProcess/API/Cocoa/WKNavigationResponse.h (modified) (1 diff)

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2014-04-02  Anders Carlsson  <andersca@apple.com>
+
+        Document WKNavigationAction and WKNavigationResponse
+        https://bugs.webkit.org/show_bug.cgi?id=131138
+
+        Reviewed by Sam Weinig.
+
+        * UIProcess/API/Cocoa/WKFrameInfo.h:
+        * UIProcess/API/Cocoa/WKNavigationAction.h:
+        * UIProcess/API/Cocoa/WKNavigationResponse.h:
+
 2014-04-03  Anders Carlsson  <andersca@apple.com>
 

trunk/Source/WebKit2/UIProcess/API/Cocoa/WKFrameInfo.h

@@ -29 +29 @@
 #if WK_API_ENABLED
 
+/*! A @link WKFrameInfo @/link object contains information about a frame on a web page.
+ @discussion WKFrameInfo objects are transient data only objects, they can not be used to uniquely 
+ identify a frame across multiple delegate method calls.
+ */
 WK_API_CLASS
 @interface WKFrameInfo : NSObject
 
+/*! @abstract Whether the frame is the main frame or a subframe.
+ */
 @property (nonatomic, readonly, getter=isMainFrame) BOOL mainFrame;
+
+/*! @abstract The current NSURLRequest of this frame.
+ */
 @property (nonatomic, readonly) NSURLRequest *request;
 

trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationAction.h

@@ -31 +31 @@
 @class WKFrameInfo;
 
+/*! @enum WKNavigationType
+ @abstract the type of action that triggered a possible navigation.
+ @constant WKNavigationTypeLinkActivated    A link with an href activated by the user.
+ @constant WKNavigationTypeFormSubmitted    A form was submitted.
+ @constant WKNavigationTypeBackForward      The user requested an item from the back forward list.
+ @constant WKNavigationTypeReload           The user reloaded a page.
+ @constant WKNavigationTypeFormResubmitted  A form as resubmitted (for example by going back, forward or reloading).
+ @constant WKNavigationTypeOther            Navigation is taking place for some other reason.
+ */
 typedef NS_ENUM(NSInteger, WKNavigationType) {
     WKNavigationTypeLinkActivated,
@@ -40 +49 @@
 };
 
+
+/*! Contains information about an action that may cause a navigation, used for making policy decisions.
+ */
 WK_API_CLASS
 @interface WKNavigationAction : NSObject
 
+/*! @abstract Represents the frame that is requesting the navigation.
+ */
 @property (nonatomic, readonly) WKFrameInfo *sourceFrame;
+
+/*! @abstract Represents the target frame. If this is a new window navigation, targetFrame will be nil.
+ */
 @property (nonatomic, readonly) WKFrameInfo *targetFrame;
 
+/*! @abstract The type of the navigation.
+ */
 @property (nonatomic, readonly) WKNavigationType navigationType;
+
+/*! @abstract The NSURLRequest of the navigation.
+ */
 @property (nonatomic, readonly) NSURLRequest *request;
 

trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationResponse.h

@@ -31 +31 @@
 @class WKFrameInfo;
 
+/*! Contains information about a navigation response, used for making policy decisions.
+ */
 WK_API_CLASS
 @interface WKNavigationResponse : NSObject
 
+/*! @abstract Represents the frame that is being navigated.
+ */
 @property (nonatomic, readonly) WKFrameInfo *frame;
+
+/*! @abstract The NSURLResponse of the frame.
+ */
 @property (nonatomic, readonly) NSURLResponse *response;
+
+/*! @abstract Whether WebKit can show the MIME type natively or not.
+ */
 @property (nonatomic, readonly) BOOL canShowMIMEType;