Title: [166672] trunk/Source/WebKit2
- Revision
- 166672
- Author
- [email protected]
- Date
- 2014-04-02 15:48:08 -0700 (Wed, 02 Apr 2014)
Log Message
Document WKBackForwardList, WKBackForwardListItem and WKWebViewConfiguration
https://bugs.webkit.org/show_bug.cgi?id=131131
Reviewed by Dan Bernstein.
* UIProcess/API/Cocoa/WKBackForwardList.h:
* UIProcess/API/Cocoa/WKBackForwardListItem.h:
* UIProcess/API/Cocoa/WKWebViewConfiguration.h:
Modified Paths
Diff
Modified: trunk/Source/WebKit2/ChangeLog (166671 => 166672)
--- trunk/Source/WebKit2/ChangeLog 2014-04-02 22:32:37 UTC (rev 166671)
+++ trunk/Source/WebKit2/ChangeLog 2014-04-02 22:48:08 UTC (rev 166672)
@@ -1,5 +1,16 @@
2014-04-02 Anders Carlsson <[email protected]>
+ Document WKBackForwardList, WKBackForwardListItem and WKWebViewConfiguration
+ https://bugs.webkit.org/show_bug.cgi?id=131131
+
+ Reviewed by Dan Bernstein.
+
+ * UIProcess/API/Cocoa/WKBackForwardList.h:
+ * UIProcess/API/Cocoa/WKBackForwardListItem.h:
+ * UIProcess/API/Cocoa/WKWebViewConfiguration.h:
+
+2014-04-02 Anders Carlsson <[email protected]>
+
Document WKUIDelegate and WKWindowFeatures
https://bugs.webkit.org/show_bug.cgi?id=131124
Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardList.h (166671 => 166672)
--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardList.h 2014-04-02 22:32:37 UTC (rev 166671)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardList.h 2014-04-02 22:48:08 UTC (rev 166672)
@@ -29,16 +29,38 @@
#import <WebKit2/WKBackForwardListItem.h>
+/*! @abstract A @link WKWebView @/link's list of previously-visited webpages that can be reached by
+ going back or forward.
+ */
WK_API_CLASS
@interface WKBackForwardList : NSObject
+/*! @abstract The current item.
+ */
@property (nonatomic, readonly) WKBackForwardListItem *currentItem;
+
+/*! @abstract The item right before the current item, or nil if there isn't one.
+ */
@property (nonatomic, readonly) WKBackForwardListItem *backItem;
+
+/*! @abstract The item right after the current item, or nil if there isn't one.
+ */
@property (nonatomic, readonly) WKBackForwardListItem *forwardItem;
+/*! @abstract Returns an entry the given distance from the current entry.
+ @param index Index of the desired list item relative to the current item; 0 is current item, -1 is back item, 1 is forward item, etc.
+ @result The entry the given distance from the current entry. If index exceeds the limits of the list, nil is returned.
+ */
- (WKBackForwardListItem *)itemAtIndex:(NSInteger)index;
+/*! @abstract Returns the portion of the list before the current entry.
+ @discussion The entries are in the order that they were originally visited.
+ */
@property (nonatomic, readonly) NSArray *backList;
+
+/*! @abstract Returns the portion of the list after the current entry.
+ @discussion The entries are in the order that they were originally visited.
+ */
@property (nonatomic, readonly) NSArray *forwardList;
@end
Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h (166671 => 166672)
--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h 2014-04-02 22:32:37 UTC (rev 166671)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h 2014-04-02 22:48:08 UTC (rev 166672)
@@ -29,11 +29,21 @@
#import <Foundation/Foundation.h>
+/*! A @link WKBackForwardListItem @/link represents a visited page in a WKWebView's back forward list.
+ */
WK_API_CLASS
@interface WKBackForwardListItem : NSObject
+/*! @abstract The URL of the page represented by this item.
+ */
@property (readonly) NSURL *URL;
+
+/*! @abstract The title of the page represented by this item.
+ */
@property (readonly) NSString *title;
+
+/*! @abstract The URL of the navigation that created this item.
+ */
@property (readonly) NSURL *initialURL;
@end
Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h (166671 => 166672)
--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h 2014-04-02 22:32:37 UTC (rev 166671)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h 2014-04-02 22:48:08 UTC (rev 166672)
@@ -32,22 +32,25 @@
@class WKProcessPool;
/*! A @link WKWebViewConfiguration @/link is a collection of properties used to initialize a web
- view.
- @helps Contains properties used to configure a @link WKWebView @/link.
-*/
+ view.
+ @helps Contains properties used to configure a @link WKWebView @/link.
+ */
WK_API_CLASS
@interface WKWebViewConfiguration : NSObject <NSCopying>
-/*! @abstract The process class of which the Web Content process for the view must be.
- @discussion When the @link WKWebView @/link is initialized with the configuration, a new Web
- content process of the specified class will be created for it, or an existing process of
- that class will be used.
-
- When this property is set to nil, a unique process class will be created for each
- @link WKWebView @/link initialized with the configuration.
+/*! @abstract The process pool from which the Web Content process for the view should come.
+ @discussion When the @link WKWebView @/link is initialized with the configuration, a new Web
+ Content process from the specified pool will be created for it, or an existing process in
+ that pool will be used.
+ When this property is set to nil, a unique process pool will be created for each
+ @link WKWebView @/link initialized with the configuration.
*/
@property (nonatomic, strong) WKProcessPool *processPool;
+/*! @abstract The preferences that should be used by web views created with this configuration.
+ @discussion When this property is set to nil, a unique preferences object will be created for each
+ @link WKWebView @/link initialized with the configuration.
+*/
@property (nonatomic, strong) WKPreferences *preferences;
@end
_______________________________________________
webkit-changes mailing list
[email protected]
https://lists.webkit.org/mailman/listinfo/webkit-changes
