Changeset 166672 in webkit


Ignore:
Timestamp:
Apr 2, 2014 3:48:08 PM (10 years ago)
Author:
andersca@apple.com
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:
Location:
trunk/Source/WebKit2
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • trunk/Source/WebKit2/ChangeLog

    r166664 r166672  
     12014-04-02  Anders Carlsson  <andersca@apple.com>
     2
     3        Document WKBackForwardList, WKBackForwardListItem and WKWebViewConfiguration
     4        https://bugs.webkit.org/show_bug.cgi?id=131131
     5
     6        Reviewed by Dan Bernstein.
     7
     8        * UIProcess/API/Cocoa/WKBackForwardList.h:
     9        * UIProcess/API/Cocoa/WKBackForwardListItem.h:
     10        * UIProcess/API/Cocoa/WKWebViewConfiguration.h:
     11
    1122014-04-02  Anders Carlsson  <andersca@apple.com>
    213

  • trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardList.h

    r166617 r166672  
    3030#import <WebKit2/WKBackForwardListItem.h>
    3131
     32/*! @abstract A @link WKWebView @/link's list of previously-visited webpages that can be reached by
     33 going back or forward.
     34 */
    3235WK_API_CLASS
    3336@interface WKBackForwardList : NSObject
    3437
     38/*! @abstract The current item.
     39 */
    3540@property (nonatomic, readonly) WKBackForwardListItem *currentItem;
     41
     42/*! @abstract The item right before the current item, or nil if there isn't one.
     43 */
    3644@property (nonatomic, readonly) WKBackForwardListItem *backItem;
     45
     46/*! @abstract The item right after the current item, or nil if there isn't one.
     47 */
    3748@property (nonatomic, readonly) WKBackForwardListItem *forwardItem;
    3849
     50/*! @abstract Returns an entry the given distance from the current entry.
     51 @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.
     52 @result The entry the given distance from the current entry. If index exceeds the limits of the list, nil is returned.
     53 */
    3954- (WKBackForwardListItem *)itemAtIndex:(NSInteger)index;
    4055
     56/*! @abstract Returns the portion of the list before the current entry.
     57 @discussion The entries are in the order that they were originally visited.
     58 */
    4159@property (nonatomic, readonly) NSArray *backList;
     60
     61/*! @abstract Returns the portion of the list after the current entry.
     62 @discussion The entries are in the order that they were originally visited.
     63 */
    4264@property (nonatomic, readonly) NSArray *forwardList;
    4365

  • trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h

    r166656 r166672  
    3030#import <Foundation/Foundation.h>
    3131
     32/*! A @link WKBackForwardListItem @/link represents a visited page in a WKWebView's back forward list.
     33 */
    3234WK_API_CLASS
    3335@interface WKBackForwardListItem : NSObject
    3436
     37/*! @abstract The URL of the page represented by this item.
     38 */
    3539@property (readonly) NSURL *URL;
     40
     41/*! @abstract The title of the page represented by this item.
     42 */
    3643@property (readonly) NSString *title;
     44
     45/*! @abstract The URL of the navigation that created this item.
     46 */
    3747@property (readonly) NSURL *initialURL;
    3848

  • trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h

    r165565 r166672  
    3333
    3434/*! A @link WKWebViewConfiguration @/link is a collection of properties used to initialize a web
    35         view.
    36     @helps Contains properties used to configure a @link WKWebView @/link.
    37 */
     35 view.
     36 @helps Contains properties used to configure a @link WKWebView @/link.
     37 */
    3838WK_API_CLASS
    3939@interface WKWebViewConfiguration : NSObject <NSCopying>
    4040
    41 /*! @abstract The process class of which the Web Content process for the view must be.
    42     @discussion When the @link WKWebView @/link is initialized with the configuration, a new Web
    43         content process of the specified class will be created for it, or an existing process of
    44         that class will be used.
    45 
    46         When this property is set to nil, a unique process class will be created for each
    47         @link WKWebView @/link initialized with the configuration.
     41/*! @abstract The process pool from which the Web Content process for the view should come.
     42 @discussion When the @link WKWebView @/link is initialized with the configuration, a new Web
     43 Content process from the specified pool will be created for it, or an existing process in
     44 that pool will be used.
     45 When this property is set to nil, a unique process pool will be created for each
     46 @link WKWebView @/link initialized with the configuration.
    4847*/
    4948@property (nonatomic, strong) WKProcessPool *processPool;
    5049
     50/*! @abstract The preferences that should be used by web views created with this configuration.
     51 @discussion When this property is set to nil, a unique preferences object will be created for each
     52 @link WKWebView @/link initialized with the configuration.
     53*/
    5154@property (nonatomic, strong) WKPreferences *preferences;
    5255
Note: See TracChangeset for help on using the changeset viewer.