[SCM] WebKit Debian packaging branch, debian/unstable, updated. debian/1.1.15-1-40151-g37bb677
kocienda
kocienda at 268f45cc-cd09-0410-ab3c-d52691b4dbfc
Sat Sep 26 07:24:44 UTC 2009
The following commit has been merged in the debian/unstable branch:
commit 64df233225675d980f31bda120a5224fa7d5c8ee
Author: kocienda <kocienda at 268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Date: Mon Feb 17 19:00:09 2003 +0000
Reviewed by Trey
Rolled in documentation changes from Peter Kelly, our tech writer.
* History.subproj/WebBackForwardList.h
* History.subproj/WebHistory.h
* Misc.subproj/WebKitErrors.h
* Misc.subproj/WebResourceResponseExtras.h
* Panels.subproj/WebStandardPanels.h
* Plugins.subproj/WebPluginError.h
* WebView.subproj/WebContextMenuDelegate.h
* WebView.subproj/WebController.h
* WebView.subproj/WebControllerPolicyDelegate.h
* WebView.subproj/WebDataSource.h
* WebView.subproj/WebDefaultPolicyDelegate.h
* WebView.subproj/WebDocument.h
* WebView.subproj/WebFrame.h
* WebView.subproj/WebPreferences.h
* WebView.subproj/WebResourceLoadDelegate.h
* WebView.subproj/WebView.h
* WebView.subproj/WebWindowOperationsDelegate.h
git-svn-id: http://svn.webkit.org/repository/webkit/trunk@3655 268f45cc-cd09-0410-ab3c-d52691b4dbfc
diff --git a/WebKit/ChangeLog b/WebKit/ChangeLog
index 298580d..9e6aa3a 100644
--- a/WebKit/ChangeLog
+++ b/WebKit/ChangeLog
@@ -1,3 +1,27 @@
+2003-02-17 Ken Kocienda <kocienda at apple.com>
+
+ Reviewed by Trey
+
+ Rolled in documentation changes from Peter Kelly, our tech writer.
+
+ * History.subproj/WebBackForwardList.h
+ * History.subproj/WebHistory.h
+ * Misc.subproj/WebKitErrors.h
+ * Misc.subproj/WebResourceResponseExtras.h
+ * Panels.subproj/WebStandardPanels.h
+ * Plugins.subproj/WebPluginError.h
+ * WebView.subproj/WebContextMenuDelegate.h
+ * WebView.subproj/WebController.h
+ * WebView.subproj/WebControllerPolicyDelegate.h
+ * WebView.subproj/WebDataSource.h
+ * WebView.subproj/WebDefaultPolicyDelegate.h
+ * WebView.subproj/WebDocument.h
+ * WebView.subproj/WebFrame.h
+ * WebView.subproj/WebPreferences.h
+ * WebView.subproj/WebResourceLoadDelegate.h
+ * WebView.subproj/WebView.h
+ * WebView.subproj/WebWindowOperationsDelegate.h
+
2003-02-13 Trey Matteson <trey at apple.com>
2943514 hide the cursor when using the arrow keys to scroll
diff --git a/WebKit/History.subproj/WebBackForwardList.h b/WebKit/History.subproj/WebBackForwardList.h
index b216d6b..918d6f7 100644
--- a/WebKit/History.subproj/WebBackForwardList.h
+++ b/WebKit/History.subproj/WebBackForwardList.h
@@ -24,45 +24,48 @@
/*!
@method setUsesPageCache:
- @param flag set to true if pages should be cached
- @abstract Pages in the back/forward list may be cached. Pages in this cache
- will load much more quickly, however they may not always be up-to-date. The
+ @param flag Set to YES if pages should be cached
+ @discussion Pages in the back/forward list may be cached. Pages in this cache
+ will load much more quickly; however, they may not always be up-to-date. The
page cache may not apply to all pages.
*/
+ (void)setUsesPageCache: (BOOL)flag;
/*!
@method usesPageCache
- @result Returns YES if the page cache is enabled.
+ @abstract Returns whether page cacheing is enabled.
+ @result YES if the page cache is enabled, otherwise NO.
*/
+ (BOOL)usesPageCache;
/*!
@method setPageCacheSize:
+ @abstract Sets the size of the page cache.
@param size The number of pages to allow in the page cache.
*/
+ (void)setPageCacheSize: (unsigned)size;
/*!
@method pageCacheSize
- @result Returns the number of pages that may be cached.
+ @abstract Returns the number of pages that may be cached.
+ @result The number of pages that may be cached.
*/
+ (unsigned)pageCacheSize;
/*!
@method clearPageCache
- @discussion Clears all items in the page cache.
+ @abstract Clears all items in the page cache.
*/
- (void)clearPageCache;
/*!
@method addEntry:
@abstract Adds an entry to the list.
- @discussion Add an entry to the back-forward list, immediately after the current entry.
+ @param entry The entry to add.
+ @discussion The added entry is inserted immediately after the current entry.
If the current position in the list is not at the end of the list, elements in the
forward list will be dropped at this point. In addition, entries may be dropped to keep
the size of the list within the maximum size.
- @param entry The entry to add.
*/
- (void)addEntry:(WebHistoryItem *)entry;
@@ -81,69 +84,81 @@
/*!
@method goToEntry:
@abstract Move the current pointer to the given entry.
+ @param entry The history item to move the pointer to
*/
- (void)goToEntry:(WebHistoryItem *)entry;
/*!
@method backEntry
- @result Returns the entry right before the current entry, or nil if there isn't one.
+ @abstract Returns the entry right before the current entry.
+ @result The entry right before the current entry, or nil if there isn't one.
*/
- (WebHistoryItem *)backEntry;
/*!
@method currentEntry
- @result Returns the current entry.
+ @abstract Returns the current entry.
+ @result The current entry.
*/
- (WebHistoryItem *)currentEntry;
/*!
@method forwardEntry
- @result Returns the entry right after the current entry, or nil if there isn't one.
+ @abstract Returns the entry right after the current entry.
+ @result The entry right after the current entry, or nil if there isn't one.
*/
- (WebHistoryItem *)forwardEntry;
/*!
@method containsEntry:
- @result Returns whether the receiver contains the given entry.
+ @abstract Returns whether the receiver contains the given entry.
+ @param entry The history item to search for.
+ @result YES if the list contains the given entry, otherwise NO.
*/
- (BOOL)containsEntry:(WebHistoryItem *)entry;
/*!
@method backListWithSizeLimit:
+ @abstract Returns a portion of the list before the current entry.
@param limit A cap on the size of the array returned.
- @result Returns a portion of the list before current entry, or nil if there are none. The entries are in the order that they were originally visited.
+ @result An array of items before the current entry, or nil if there are none. The entries are in the order that they were originally visited.
*/
- (NSArray *)backListWithSizeLimit:(int)limit;
/*!
@method forwardListWithSizeLimit:
+ @abstract Returns a portion of the list after the current entry.
@param limit A cap on the size of the array returned.
- @result Returns a portion of the list after current entry, or nil if there are none. The entries are in the order that they were originally visited.
+ @result An array of items after the current entry, or nil if there are none. The entries are in the order that they were originally visited.
*/
- (NSArray *)forwardListWithSizeLimit:(int)limit;
/*!
@method maximumSize
- @result Returns this list's maximum size.
+ @abstract Returns the list's maximum size.
+ @result The list's maximum size.
*/
- (int)maximumSize;
/*!
@method maximumSize
- @abstract Sets this list's maximum size.
+ @abstract Sets the list's maximum size.
+ @param size The new maximum size for the list.
*/
- (void)setMaximumSize:(int)size;
/*!
@method backListCount
- @result Returns the back list's current count.
+ @abstract Returns the back list's current count.
+ @result The number of items in the list.
*/
- (int)backListCount;
/*!
@method entryAtIndex:
- @param index Index of the back/forward list item; 0 is current item, -1 is back item, 1 is forward item, etc.
- @result Returns an entry the given distance from the current entry, or the furthest in that direction if there is none.
+ @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, the entry furthest in that direction is returned.
*/
- (WebHistoryItem *)entryAtIndex:(int)index;
diff --git a/WebKit/History.subproj/WebHistory.h b/WebKit/History.subproj/WebHistory.h
index c98e6cc..40d0e06 100644
--- a/WebKit/History.subproj/WebHistory.h
+++ b/WebKit/History.subproj/WebHistory.h
@@ -32,6 +32,11 @@ extern NSString *WebHistoryLoadedNotification;
WebHistoryPrivate *_historyPrivate;
}
+/*!
+ @method sharedHistory
+ @abstract Returns a shared WebHistory instance initialized with the default history file.
+ @result A WebHistory object.
+*/
+ (WebHistory *)sharedHistory;
/*!
@@ -42,26 +47,33 @@ extern NSString *WebHistoryLoadedNotification;
+ (WebHistory *)createSharedHistoryWithFile: (NSString*)file;
/*!
+ @method initWithFile:
+ @abstract The designated initializer for WebHistory.
+ @result Returns an initialized WebHistory.
+*/
+- initWithFile: (NSString *)file;
+
+/*!
@method addEntry:
- @param entry
+ @param entry The history item to add to the WebHistory.
*/
- (void)addEntry: (WebHistoryItem *)entry;
/*!
@method addEntries:
- @param newEntries
+ @param newEntries An array of WebHistoryItems to add to the WebHistory.
*/
- (void)addEntries:(NSArray *)newEntries;
/*!
@method removeEntry:
- @param entry
+ @param entry The WebHistoryItem to remove from the WebHistory.
*/
- (void)removeEntry: (WebHistoryItem *)entry;
/*!
@method removeEntries:
- @param entries
+ @param entries An array of WebHistoryItems to remove from the WebHistory.
*/
- (void)removeEntries: (NSArray *)entries;
@@ -72,9 +84,9 @@ extern NSString *WebHistoryLoadedNotification;
/*!
@method orderedLastVisitedDays
- @discussion Get an array of NSCalendarDate, each one representing a unique day that contains one
+ @discussion Get an array of NSCalendarDates, each one representing a unique day that contains one
or more history entries, ordered from most recent to oldest.
- @result Returns an array of WebHistoryItems
+ @result Returns an array of NSCalendarDates for which history items exist in the WebHistory.
*/
- (NSArray *)orderedLastVisitedDays;
@@ -82,22 +94,24 @@ extern NSString *WebHistoryLoadedNotification;
@method orderedEntriesLastVisitedOnDay:
@discussion Get an array of WebHistoryItem that were last visited on the day represented by the
specified NSCalendarDate, ordered from most recent to oldest.
- @param calendarDate
- @result Returns an array of WebHistoryItems
+ @param calendarDate A date identifying the unique day of interest.
+ @result Returns an array of WebHistoryItems last visited on the indicated day.
*/
- (NSArray *)orderedEntriesLastVisitedOnDay: (NSCalendarDate *)calendarDate;
/*!
@method containsURL:
- @param URL
- @discussion testing contents for visited-link mechanism
+ @abstract Return whether a URL is in the WebHistory.
+ @param URL The URL for which to search the WebHistory.
+ @discussion This method is useful for implementing a visited-link mechanism.
+ @result YES if WebHistory contains a history item for the given URL, otherwise NO.
*/
- (BOOL)containsURL: (NSURL *)URL;
/*!
@method entryForURL:
- @discussion Get an item for a specific URL
- @param URL
+ @abstract Get an item for a specific URL
+ @param URL The URL of the history item to search for
@result Returns an item matching the URL
*/
- (WebHistoryItem *)entryForURL:(NSURL *)URL;
@@ -110,9 +124,16 @@ extern NSString *WebHistoryLoadedNotification;
- (NSString *)file;
/*!
+ @method loadHistory
+ @discussion Load history from file. This happens automatically at init time, and need not normally be called.
+ @result Returns YES if successful, NO otherwise.
+*/
+- (BOOL)loadHistory;
+
+/*!
@method saveHistory
@discussion Save history to file. It is the client's responsibility to call this at appropriate times.
- @result Returns YES if successful, not otherwise.
+ @result Returns YES if successful, NO otherwise.
*/
- (BOOL)saveHistory;
diff --git a/WebKit/Misc.subproj/WebKitErrors.h b/WebKit/Misc.subproj/WebKitErrors.h
index 589792b..7357438 100644
--- a/WebKit/Misc.subproj/WebKitErrors.h
+++ b/WebKit/Misc.subproj/WebKitErrors.h
@@ -22,6 +22,10 @@ extern NSString *WebErrorDomainWebKit;
@constant WebKitErrorCannotShowMIMEType
@constant WebKitErrorCannotShowURL
@constant WebKitErrorLocationChangeInterruptedByPolicyChange
+ @constant WebKitErrorResourceLoadInterruptedByPolicyChange
+ @constant WebKitErrorCannotFindPlugin
+ @constant WebKitErrorCannotLoadPlugin
+ @constant WebKitErrorJavaUnavailable
@constant WebKitErrorDownloadDecodingFailedMidStream
@constant WebKitErrorDownloadDecodingFailedToComplete
*/
diff --git a/WebKit/Misc.subproj/WebNSURLResponseExtras.h b/WebKit/Misc.subproj/WebNSURLResponseExtras.h
index 8292156..e72435b 100644
--- a/WebKit/Misc.subproj/WebNSURLResponseExtras.h
+++ b/WebKit/Misc.subproj/WebNSURLResponseExtras.h
@@ -19,6 +19,7 @@
If the URL's host can't be converted to a valid filename, the filename "unknown" is used.
In mose cases, this method appends the proper file extension based on the MIME type.
This method always returns a valid filename.
+ @result A suggested filename to use if saving the resource to disk.
*/
- (NSString *)suggestedFilenameForSaving;
diff --git a/WebKit/Misc.subproj/WebResourceResponseExtras.h b/WebKit/Misc.subproj/WebResourceResponseExtras.h
index 8292156..e72435b 100644
--- a/WebKit/Misc.subproj/WebResourceResponseExtras.h
+++ b/WebKit/Misc.subproj/WebResourceResponseExtras.h
@@ -19,6 +19,7 @@
If the URL's host can't be converted to a valid filename, the filename "unknown" is used.
In mose cases, this method appends the proper file extension based on the MIME type.
This method always returns a valid filename.
+ @result A suggested filename to use if saving the resource to disk.
*/
- (NSString *)suggestedFilenameForSaving;
diff --git a/WebKit/Panels.subproj/WebStandardPanels.h b/WebKit/Panels.subproj/WebStandardPanels.h
index 0301f47..52150c1 100644
--- a/WebKit/Panels.subproj/WebStandardPanels.h
+++ b/WebKit/Panels.subproj/WebStandardPanels.h
@@ -37,7 +37,7 @@
/*!
@method usesStandardAuthenticationPanel
- @abstract Determine whether the standard authentication panelwill be used or not used.
+ @abstract Determine whether the standard authentication panel will be used or not used.
@result YES if the standard authentication panel should be used, NO otherwise
*/
-(BOOL)usesStandardAuthenticationPanel;
@@ -49,7 +49,7 @@
@param window The window associated with the load.
@discussion This is only needed for resources that are not being
loaded via WebKit. WebKit takes care of this bookkeeping
- automatically, for resources that it loads.
+ automatically for resources that it loads.
*/
-(void)didStartLoadingURL:(NSURL *)URL inWindow:(NSWindow *)window;
@@ -60,7 +60,7 @@
@param window The window associated with the load.
@discussion This is only needed for resources that are not being
loaded via WebKit. WebKit takes care of this bookkeeping
- automatically, for resources that it loads.
+ automatically for resources that it loads.
*/
-(void)didStopLoadingURL:(NSURL *)URL inWindow:(NSWindow *)window;
@@ -68,6 +68,7 @@
@method frontmostWindowLoadingURL:
@abstract Get the frontmost window loading a URL
@param URL The URL in question
+ @result The frontmost window loading the given URL
@discussion This may be useful for clients that want to implement their
own custom panels for special purposes.
*/
diff --git a/WebKit/Plugins.subproj/WebPlugInError.h b/WebKit/Plugins.subproj/WebPlugInError.h
index 34fd6ab..1702ef7 100644
--- a/WebKit/Plugins.subproj/WebPlugInError.h
+++ b/WebKit/Plugins.subproj/WebPlugInError.h
@@ -12,7 +12,6 @@
@class WebPluginErrorPrivate;
-
/*!
@class WebPluginError
@discussion WebPluginError is a subclass of WebError that is specific to plug-in related errors.
@@ -25,27 +24,22 @@
/*!
@method contentURL
- @abstract The URL specified by the SRC attribute of the EMBED or PARAM tag.
+ @result The URL of the data that caused the error
*/
- (NSString *)contentURL;
-
/*!
@method pluginPageURL
- @abstract The URL specified by the PLUGINSPAGE attribute of the EMBED or PARAM tag.
- @discussion This is the URL for the page that has information about the plug-in. May be nil.
+ @result Description forthcoming
*/
- (NSString *)pluginPageURL;
-
/*!
@method pluginName
- @abstract The name of the plug-in that had the error. May be nil.
+ @result The name of plugin that experienced the error
*/
- (NSString *)pluginName;
-
/*!
@method MIMEType
- @abstract The MIME type specified by the TYPE attribute of the EMBED or PARAM tag.
- @discussion The MIME type of the content. May be nil.
+ @result The MIME type of the data that caused the error
*/
- (NSString *)MIMEType;
diff --git a/WebKit/WebView.subproj/WebContextMenuDelegate.h b/WebKit/WebView.subproj/WebContextMenuDelegate.h
index c7d0c18..6cd9db7 100644
--- a/WebKit/WebView.subproj/WebContextMenuDelegate.h
+++ b/WebKit/WebView.subproj/WebContextMenuDelegate.h
@@ -33,8 +33,10 @@ enum {
/*!
@method contextMenuItemsForElement:defaultMenuItems:
- @discussion Returns the array of NSMenuItems that will be displayed in the context menu
- for the dictionary representation of the clicked element.
+ @abstract Returns the menu items to display in an element's contextual menu.
+ @param element A dictionary representation of the clicked element.
+ @param defaultMenuItems An array of default NSMenuItems to include in all contextual menus.
+ @result An array of NSMenuItems to include in the contextual menu.
*/
- (NSArray *)contextMenuItemsForElement:(NSDictionary *)element defaultMenuItems:(NSArray *)defaultMenuItems;
diff --git a/WebKit/WebView.subproj/WebController.h b/WebKit/WebView.subproj/WebController.h
index 75915a1..fd666b5 100644
--- a/WebKit/WebView.subproj/WebController.h
+++ b/WebKit/WebView.subproj/WebController.h
@@ -34,7 +34,7 @@ extern NSString *WebElementImageKey; // NSImage of the image element
extern NSString *WebElementImageRectKey; // NSValue of an NSRect, the rect of the image element
extern NSString *WebElementImageURLKey; // NSURL of the image element
extern NSString *WebElementIsSelectedTextKey; // NSNumber of BOOL indicating whether the element is selected text or not
-extern NSString *WebElementLinkURLKey; // NSURL if the element is within an anchor
+extern NSString *WebElementLinkURLKey; // NSURL of the link if the element is within an anchor
extern NSString *WebElementLinkTargetFrameKey; // NSString of the target of the anchor
extern NSString *WebElementLinkTitleKey; // NSString of the title of the anchor
extern NSString *WebElementLinkLabelKey; // NSString of the text within the anchor
@@ -103,10 +103,8 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@method initWithView:controllerSetName:
@abstract The designated initializer for WebController.
@discussion Initialize a WebController with the supplied parameters. This method
- will create a main WebFrame with the view and datasource. The frame will be
- named "_top".
+ will create a main WebFrame with the view. The frame will be named "_top".
@param view The main view to be associated with the controller. May be nil.
- @param dataSource The main datasource to be associated with the controller. May be nil.
@param name The name of the controller set to which this controller will be added. May be nil.
@result Returns an initialized WebController.
*/
@@ -121,14 +119,15 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method windowOperationsDelegate
- @result Return the controller's WebWindowOperationsDelegate.
+ @abstract Return the controller's WebWindowOperationsDelegate.
+ @result The controller's WebWindowOperationsDelegate.
*/
- (id<WebWindowOperationsDelegate>)windowOperationsDelegate;
/*!
@method setResourceLoadDelegate:
- @abstract Set the controller's WebResourceLoadDelegate.
- @param delegate The WebResourceLoadDelegate to set as the delegate.
+ @abstract Set the controller's WebResourceLoadDelegate load delegate.
+ @param delegate The WebResourceLoadDelegate to set as the load delegate.
*/
- (void)setResourceLoadDelegate: (id<WebResourceLoadDelegate>)delegate;
@@ -147,20 +146,22 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method downloadDelegate
- @result Return the controller's WebResourceLoadDelegate download delegate.
+ @abstract Return the controller's WebResourceLoadDelegate download delegate.
+ @result The controller's WebResourceLoadDelegate download delegate.
*/
- (id<WebResourceLoadDelegate>)downloadDelegate;
/*!
@method setContextMenuDelegate:
- @abstract Set the controller's WebContextMenuDelegate download delegate.
- @param delegate The WebContextMenuDelegate to set as the download delegate.
+ @abstract Set the controller's WebContextMenuDelegate.
+ @param delegate The WebContextMenuDelegate to set as the delegate.
*/
- (void)setContextMenuDelegate: (id<WebContextMenuDelegate>)delegate;
/*!
@method contextMenuDelegate
- @result Return the controller's WebContextMenuDelegate.
+ @abstract Return the controller's WebContextMenuDelegate.
+ @result The controller's WebContextMenuDelegate.
*/
- (id<WebContextMenuDelegate>)contextMenuDelegate;
@@ -173,7 +174,8 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method locationChangeDelegate
- @result Return the controller's WebLocationChangeDelegate.
+ @abstract Return the controller's WebLocationChangeDelegate delegate.
+ @result The controller's WebLocationChangeDelegate delegate.
*/
- (id <WebLocationChangeDelegate>)locationChangeDelegate;
@@ -186,7 +188,8 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method policyDelegate
- @result Return the controller's WebControllerPolicyDelegate.
+ @abstract Return the controller's WebControllerPolicyDelegate.
+ @result The controller's WebControllerPolicyDelegate.
*/
- (id<WebControllerPolicyDelegate>)policyDelegate;
@@ -227,34 +230,35 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method setUseBackForwardList:
@abstract Enable or disable the use of a backforward list for this controller.
- @param flag turns use of the back forward list on or off
+ @param flag Turns use of the back forward list on or off
*/
- (void)setUsesBackForwardList: (BOOL)flag;
/*!
@method useBackForwardList
- @result Returns YES if a backforward list is being used by this controller, NO otherwise.
+ @result Returns whether a backforward list is being used by this controller.
+ @result YES if a backforward list is being used by this controller, NO otherwise.
*/
- (BOOL)usesBackForwardList;
/*!
@method goBack
@abstract Go back to the previous URL in the backforward list.
- @result Returns YES if able to go back in the backforward list, NO otherwise.
+ @result YES if able to go back in the backforward list, NO otherwise.
*/
- (BOOL)goBack;
/*!
@method goForward
@abstract Go forward to the next URL in the backforward list.
- @result Returns YES if able to go forward in the backforward list, NO otherwise.
+ @result YES if able to go forward in the backforward list, NO otherwise.
*/
- (BOOL)goForward;
/*!
@method goBackOrForwardToItem:
@abstract Go back or forward to an item in the backforward list.
- @result Returns YES if able to go to the item, NO otherwise.
+ @result YES if able to go to the item, NO otherwise.
*/
- (BOOL)goBackOrForwardToItem:(WebHistoryItem *)item;
@@ -267,7 +271,7 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method textSizeMultiplier
- @result Returns the text size multipler.
+ @result The text size multipler.
*/
- (float)textSizeMultiplier;
@@ -276,22 +280,22 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@abstract Set the application name.
@discussion This name will be used in user-agent strings
that are chosen for best results in rendering web pages.
- @param applicationName the application name
+ @param applicationName The application name
*/
- (void)setApplicationNameForUserAgent:(NSString *)applicationName;
/*!
@method applicationNameForUserAgent
- @result Returns the name of the application as used in the user-agent string.
+ @result The name of the application as used in the user-agent string.
*/
- (NSString *)applicationNameForUserAgent;
/*!
- @method setUserAgent:
+ @method setCustomUserAgent:
@abstract Set the user agent.
@discussion Setting this means that the controller should use this user-agent string
instead of constructing a user-agent string for each URL.
- @param userAgentString the user agent description
+ @param userAgentString The user agent description
*/
- (void)setCustomUserAgent:(NSString *)userAgentString;
@@ -300,7 +304,6 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@abstract Reset the user agent.
@discussion Causes the controller to construct the user-agent string for each URL
for best results rendering web pages.
- @param userAgentString the user agent description
*/
- (void)resetUserAgent;
@@ -308,13 +311,13 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@method hasCustomUserAgent
@abstract Determine whether or not a custom user-agent string is in use.
@discussion It's an error to call customUserAgent if hasCustomUserAgent is NO.
- @result Returns YES if a custom encoding has been set, NO otherwise.
+ @result YES if a custom user agent has been set, NO otherwise.
*/
- (BOOL)hasCustomUserAgent;
/*!
@method customUserAgent
- @result customUserAgent Returns the custom user-agent string. Should only be called
+ @result The custom user-agent string. Should only be called
if hasCustomUserAgent returns YES.
*/
- (NSString *)customUserAgent;
@@ -323,14 +326,14 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@method userAgentForURL:
@abstract Get the appropriate user-agent string for a particular URL.
@param URL The URL.
- @result Returns the user-agent string for the supplied URL.
+ @result The user-agent string for the supplied URL.
*/
- (NSString *)userAgentForURL:(NSURL *)URL;
/*!
@method supportsTextEncoding
@abstract Find out if the current web page supports text encodings.
- @result Returns YES if the document view of the current web page can
+ @result YES if the document view of the current web page can
support different text encodings.
*/
- (BOOL)supportsTextEncoding;
@@ -342,7 +345,7 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
what's specified in a web page's header or HTTP response.
The text encoding automatically goes back to the default when the top level frame
changes to a new location.
- @param encoding
+ @param encoding The text encoding to use to display a page.
*/
- (void)setCustomTextEncodingName:(NSString *)encoding;
@@ -356,20 +359,20 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@method hasCustomTextEncoding
@abstract Determine whether or not a custom text encoding is in use.
@discussion It's an error to call customTextEncoding if hasCustomTextEncoding is NO.
- @result Returns YES if a custom encoding has been set, NO otherwise.
+ @result YES if a custom encoding has been set, NO otherwise.
*/
- (BOOL)hasCustomTextEncoding;
/*!
@method customTextEncoding
- @result Returns the custom text encoding.
+ @result The custom text encoding.
*/
- (NSString *)customTextEncodingName;
/*!
@method stringByEvaluatingJavaScriptFromString:
@param script The text of the JavaScript.
- @result Returns the result of the script, converted to a string, or nil for failure.
+ @result The result of the script, converted to a string, or nil for failure.
*/
- (NSString *)stringByEvaluatingJavaScriptFromString:(NSString *)script;
diff --git a/WebKit/WebView.subproj/WebControllerPolicyDelegate.h b/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
index ef5fada..42753ba 100644
--- a/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
+++ b/WebKit/WebView.subproj/WebControllerPolicyDelegate.h
@@ -44,6 +44,7 @@ extern NSString *WebActionOriginalURLKey; // NSURL
/*!
@enum WebPolicyAction
+ @abstract Potential actions to take when loading a URL
@constant WebPolicyNone Unitialized state.
@constant WebPolicyUse Have WebKit use the resource.
@constant WebPolicyRevealInFinder Reveal the file in the Finder.
@@ -52,6 +53,7 @@ extern NSString *WebActionOriginalURLKey; // NSURL
@constant WebPolicyOpenNewWindow Open the resource in another window.
@constant WebPolicyOpenNewWindowBehind Open the resource in another window behind this window.
@constant WebPolicyIgnore Do nothing with the resource.
+ @constant WebPolicyShow Description forthcoming.
*/
typedef enum {
WebPolicyNone,
@@ -85,29 +87,29 @@ typedef enum {
policies that determine the action of what to do with the URL or the data that
the URL represents. Typically, the policy handler methods are called in this order:
- navigationPolicyForAction:andRequest:inFrame:<BR>
+ decideNavigationPolicyForAction:andRequest:inFrame:decisionListener:<BR>
contentPolicyForMIMEType:andRequest:inFrame:<BR>
*/
@protocol WebControllerPolicyDelegate <NSObject>
/*!
- @method decideNavigationPolicyForAction:andRequest:inFrame:
+ @method decideNavigationPolicyForAction:andRequest:inFrame:decisionListener:
@discussion Called right after the user clicks on a link.
@param actionInformation Dictionary that describes the action that triggered this navigation.
- @param andRequest The request for the proposed navigation
+ @param request The request for the proposed navigation
@param frame The frame in which the navigation is taking place
@param listener The object to call when the decision is made
*/
- (void)decideNavigationPolicyForAction:(NSDictionary *)actionInformation
- andRequest:(WebResourceRequest *)request
- inFrame:(WebFrame *)frame
- decisionListener:(WebPolicyDecisionListener *)listener;
+ andRequest:(WebResourceRequest *)request
+ inFrame:(WebFrame *)frame
+ decisionListener:(WebPolicyDecisionListener *)listener;
/*!
- @method contentPolicyForResponse:andRequest:inFrame:withContentPolicy:
+ @method contentPolicyForMIMEType:andRequest:inFrame:
@discussion Returns the policy for content which has been partially loaded. Sent after locationChangeStarted.
- @param type MIME type for the file.
+ @param type MIME type for the resource.
@param request A WebResourceRequest for the partially loaded content.
@param frame The frame which is loading the URL.
*/
@@ -118,9 +120,10 @@ typedef enum {
/*!
@method saveFilenameForResponse:andRequest:
- @discussion Returns the filename to use to for a load that's being saved.
+ @discussion Returns the filename to use for a load that's being saved.
@param response The response for the partially loaded content.
@param request A WebResourceRequest for the partially loaded content.
+ @result The filename to use to save a loaded resource.
*/
- (NSString *)savePathForResponse:(WebResourceResponse *)response
andRequest:(WebResourceRequest *)request;
@@ -131,7 +134,8 @@ typedef enum {
@discussion Called when a WebPolicy could not be implemented. It is up to the client to display appropriate feedback.
@param policy The policy that could not be implemented.
@param error The error that caused the policy to not be implemented.
- @param frame The frame in the which the policy could not be implemented.
+ @param URL The URL of the resource for which a particular action was requested but failed.
+ @param frame The frame in which the policy could not be implemented.
*/
- (void)unableToImplementPolicy:(WebPolicyAction)policy error:(WebError *)error forURL:(NSURL *)URL inFrame:(WebFrame *)frame;
diff --git a/WebKit/WebView.subproj/WebDataSource.h b/WebKit/WebView.subproj/WebDataSource.h
index 5943284..fd22d72 100644
--- a/WebKit/WebView.subproj/WebDataSource.h
+++ b/WebKit/WebView.subproj/WebDataSource.h
@@ -22,7 +22,7 @@
@discussion A WebDataSource represents the data associated with a web page.
A datasource has a WebDocumentRepresentation which holds an appropriate
representation of the data. WebDataSources manage a hierarchy of WebFrames.
- WebDataSources are typically related to a view by there containg WebFrame.
+ WebDataSources are typically related to a view by their containing WebFrame.
*/
@interface WebDataSource : NSObject
{
@@ -49,7 +49,7 @@
/*!
@method data
@discussion The data associated with a datasource will not be valid until
- a datasource has completed loaded.
+ a datasource has completely loaded.
@result Returns the raw data associated with this datasource. Returns nil
if the datasource hasn't loaded.
*/
@@ -87,9 +87,7 @@
/*!
@method request
- @result Returns the request that is used for this datasource. This
- request may have changed from the original request because of canonicalization
- of the URL, addition of headers, and/or redirects.
+ @result Returns the request that was used to create this datasource.
*/
-(WebResourceRequest *)request;
@@ -102,7 +100,7 @@
/*!
@method URL
@discussion The value of URL will change if a redirect occurs.
- To monitor change in the URL, override the <WebLocationChangeHandler>
+ To monitor change in the URL, override the <WebLocationChangeDelegate>
serverRedirectedForDataSource: method.
@result Returns the current URL associated with the datasource.
*/
@@ -144,7 +142,7 @@
/*!
@method frameName
- @result frameName The name of frame that contains this datasource.
+ @result The name of frame that contains this datasource.
*/
- (NSString *)frameName;
@@ -170,7 +168,16 @@
- (NSString *)stringWithData:(NSData *)data;
+/*!
+ @method isDownloading
+ @result Description forthcoming.
+*/
- (BOOL)isDownloading;
+
+/*!
+ @method downloadPath
+ @result Description forthcoming.
+*/
- (NSString *)downloadPath;
@@ -182,8 +189,8 @@
a subtype, i.e. "video/" will match the document class with
all video types. More specific matching takes precedence
over general matching.
- @param repClass
- @param MIMEType
+ @param repClass The WebDocumentRepresentation class to use to represent data of the given MIME type.
+ @param MIMEType The MIME type to represent with an object of the given class.
*/
+ (void) registerRepresentationClass:(Class)repClass forMIMEType:(NSString *)MIMEType;
diff --git a/WebKit/WebView.subproj/WebDefaultPolicyDelegate.h b/WebKit/WebView.subproj/WebDefaultPolicyDelegate.h
index a3b28f5..42f35bd 100644
--- a/WebKit/WebView.subproj/WebDefaultPolicyDelegate.h
+++ b/WebKit/WebView.subproj/WebDefaultPolicyDelegate.h
@@ -8,7 +8,7 @@
/*!
@class WebDefaultPolicyDelegate
- @discussion WebDefaultPolicyDelegate will be used a a WebController's
+ @discussion WebDefaultPolicyDelegate will be used as a WebController's
default policy delegate. It can be subclassed to modify policies.
*/
@interface WebDefaultPolicyDelegate : NSObject <WebControllerPolicyDelegate>
diff --git a/WebKit/WebView.subproj/WebDocument.h b/WebKit/WebView.subproj/WebDocument.h
index c9a7b2d..79fe72b 100644
--- a/WebKit/WebView.subproj/WebDocument.h
+++ b/WebKit/WebView.subproj/WebDocument.h
@@ -96,8 +96,8 @@
/*!
- @protocol WebDocumentTextEncoding
- @discussion Optional protocol for supporting text encoding.
+ @protocol WebDocumentText
+ @discussion Optional protocol for supporting text operations.
*/
@protocol WebDocumentText <NSObject>
@@ -176,7 +176,7 @@
- (void)receivedError: (WebError *)error withDataSource: (WebDataSource *)dataSource;
/*!
- @method finishLoadingWithDataSource:
+ @method finishedLoadingWithDataSource:
@abstract Called when the data source has finished loading.
@param dataSource The datasource that has finished loading.
*/
@@ -194,4 +194,5 @@
this is the original HTML source.
*/
- (NSString *)documentSource;
+
@end
diff --git a/WebKit/WebView.subproj/WebFrame.h b/WebKit/WebView.subproj/WebFrame.h
index 3263743..08e11a5 100644
--- a/WebKit/WebView.subproj/WebFrame.h
+++ b/WebKit/WebView.subproj/WebFrame.h
@@ -44,7 +44,7 @@
/*!
@method setController:
- @param controller
+ @param controller The controller to assign to this frame.
*/
- (void)setController: (WebController *)controller;
@@ -56,7 +56,7 @@
/*!
@method setWebView:
- @param view
+ @param view The view to assign to this frame.
*/
- (void)setWebView: (WebView *)view;
@@ -68,6 +68,7 @@
/*!
@method loadRequest:
+ @param request The web request to load.
*/
-(void)loadRequest:(WebResourceRequest *)request;
@@ -82,7 +83,7 @@
/*!
@method provisionalDataSource
@discussion Will return the provisional data source. The provisional data source will
- return nil if no data source has been set on the frame, or the data source
+ be nil if no data source has been set on the frame, or the data source
has successfully transitioned to the committed data source.
@result The provisional datasource of this frame.
*/
@@ -104,7 +105,7 @@
@method findFrameNamed:
@discussion This method returns a frame with the given name. findFrameNamed returns self
for _self and _current, the parent frame for _parent and the main frame for _top.
- findFrameNamed returns self for _parent and _top if the receiver it is the mainFrame.
+ findFrameNamed returns self for _parent and _top if the receiver is the mainFrame.
findFrameNamed first searches from the current frame to all descending frames then the
rest of the frames in the controller. If still not found, findFrameNamed searches the
frames of the other controllers.
diff --git a/WebKit/WebView.subproj/WebFrameView.h b/WebKit/WebView.subproj/WebFrameView.h
index 9c6bf7a..1c0db20 100644
--- a/WebKit/WebView.subproj/WebFrameView.h
+++ b/WebKit/WebView.subproj/WebFrameView.h
@@ -24,53 +24,64 @@
/*!
@method initWithFrame:
- @param frame
+ @param frame The frame rectangle for the view
+ @result An initialized WebView
*/
- initWithFrame: (NSRect) frame;
/*!
@method controller
- @discussion Note that the controller is not retained.
+ @abstract Returns the WebController associated with this WebView
+ @result The WebView's controller
*/
- (WebController *)controller;
/*!
@method frameScrollView
+ @abstract Returns the WebView's scroll view
+ @result The scrolling view used by the WebView to display its document view
*/
- (NSScrollView *)frameScrollView;
/*!
@method documentView
+ @abstract Returns the WebView's document subview
+ @result The subview that renders the WebView's contents
*/
- (NSView <WebDocumentView> *)documentView;
/*!
@method isDocumentHTML
- @result Returns TRUE is the document represented in the view is HTML.
+ @abstract Returns whether the WebView's document view is rendering HTML content
+ @result YES if the document represented in the view is HTML, otherwise NO.
*/
- (BOOL)isDocumentHTML;
/*!
@method setAllowsScrolling:
- @param flag
+ @abstract Sets whether the WebView allows its document to be scrolled
+ @param flag YES to allow the document to be scrolled, NO to disallow scrolling
*/
- (void)setAllowsScrolling: (BOOL)flag;
/*!
@method allowsScrolling
+ @abstract Returns whether the WebView allows its document to be scrolled
+ @result YES if the document is allowed to scroll, otherwise NO
*/
- (BOOL)allowsScrolling;
/*!
@method registerViewClass:forMIMEType:
+ @abstract Registers an NSView subclass to use to render data of the given MIME type
@discussion Extends the views that WebKit supports.
The view must conform to the WebDocumentView protocol
A view may register for a primary MIME type by excluding
a subtype, i.e. "video/" will match the view with
all video types. More specific matching takes precedence
over general matching.
- @param viewClass
- @param MIMEType
+ @param viewClass The NSView subclass to instantiate when rendering data of the given MIME type
+ @param MIMEType The MIME type for which to instantiate the given class
*/
+ (void)registerViewClass:(Class)viewClass forMIMEType:(NSString *)MIMEType;
diff --git a/WebKit/WebView.subproj/WebPolicyDelegate.h b/WebKit/WebView.subproj/WebPolicyDelegate.h
index ef5fada..42753ba 100644
--- a/WebKit/WebView.subproj/WebPolicyDelegate.h
+++ b/WebKit/WebView.subproj/WebPolicyDelegate.h
@@ -44,6 +44,7 @@ extern NSString *WebActionOriginalURLKey; // NSURL
/*!
@enum WebPolicyAction
+ @abstract Potential actions to take when loading a URL
@constant WebPolicyNone Unitialized state.
@constant WebPolicyUse Have WebKit use the resource.
@constant WebPolicyRevealInFinder Reveal the file in the Finder.
@@ -52,6 +53,7 @@ extern NSString *WebActionOriginalURLKey; // NSURL
@constant WebPolicyOpenNewWindow Open the resource in another window.
@constant WebPolicyOpenNewWindowBehind Open the resource in another window behind this window.
@constant WebPolicyIgnore Do nothing with the resource.
+ @constant WebPolicyShow Description forthcoming.
*/
typedef enum {
WebPolicyNone,
@@ -85,29 +87,29 @@ typedef enum {
policies that determine the action of what to do with the URL or the data that
the URL represents. Typically, the policy handler methods are called in this order:
- navigationPolicyForAction:andRequest:inFrame:<BR>
+ decideNavigationPolicyForAction:andRequest:inFrame:decisionListener:<BR>
contentPolicyForMIMEType:andRequest:inFrame:<BR>
*/
@protocol WebControllerPolicyDelegate <NSObject>
/*!
- @method decideNavigationPolicyForAction:andRequest:inFrame:
+ @method decideNavigationPolicyForAction:andRequest:inFrame:decisionListener:
@discussion Called right after the user clicks on a link.
@param actionInformation Dictionary that describes the action that triggered this navigation.
- @param andRequest The request for the proposed navigation
+ @param request The request for the proposed navigation
@param frame The frame in which the navigation is taking place
@param listener The object to call when the decision is made
*/
- (void)decideNavigationPolicyForAction:(NSDictionary *)actionInformation
- andRequest:(WebResourceRequest *)request
- inFrame:(WebFrame *)frame
- decisionListener:(WebPolicyDecisionListener *)listener;
+ andRequest:(WebResourceRequest *)request
+ inFrame:(WebFrame *)frame
+ decisionListener:(WebPolicyDecisionListener *)listener;
/*!
- @method contentPolicyForResponse:andRequest:inFrame:withContentPolicy:
+ @method contentPolicyForMIMEType:andRequest:inFrame:
@discussion Returns the policy for content which has been partially loaded. Sent after locationChangeStarted.
- @param type MIME type for the file.
+ @param type MIME type for the resource.
@param request A WebResourceRequest for the partially loaded content.
@param frame The frame which is loading the URL.
*/
@@ -118,9 +120,10 @@ typedef enum {
/*!
@method saveFilenameForResponse:andRequest:
- @discussion Returns the filename to use to for a load that's being saved.
+ @discussion Returns the filename to use for a load that's being saved.
@param response The response for the partially loaded content.
@param request A WebResourceRequest for the partially loaded content.
+ @result The filename to use to save a loaded resource.
*/
- (NSString *)savePathForResponse:(WebResourceResponse *)response
andRequest:(WebResourceRequest *)request;
@@ -131,7 +134,8 @@ typedef enum {
@discussion Called when a WebPolicy could not be implemented. It is up to the client to display appropriate feedback.
@param policy The policy that could not be implemented.
@param error The error that caused the policy to not be implemented.
- @param frame The frame in the which the policy could not be implemented.
+ @param URL The URL of the resource for which a particular action was requested but failed.
+ @param frame The frame in which the policy could not be implemented.
*/
- (void)unableToImplementPolicy:(WebPolicyAction)policy error:(WebError *)error forURL:(NSURL *)URL inFrame:(WebFrame *)frame;
diff --git a/WebKit/WebView.subproj/WebPreferences.h b/WebKit/WebView.subproj/WebPreferences.h
index f2f87b8..fb2a8ff 100644
--- a/WebKit/WebView.subproj/WebPreferences.h
+++ b/WebKit/WebView.subproj/WebPreferences.h
@@ -194,7 +194,7 @@ extern NSString *WebPreferencesChangedNotification;
- (BOOL)pluginsEnabled;
/*!
- @method setJavaScriptCanOpenWindowsAutomatically:
+ @method setPluginsEnabled:
@param flag
*/
- (void)setPluginsEnabled:(BOOL)flag;
@@ -228,8 +228,7 @@ extern NSString *WebPreferencesChangedNotification;
- (void)setWillLoadImagesAutomatically: (BOOL)flag;
/*!
- @method willLoadImagesAutomatically:
- @param flag
+ @method willLoadImagesAutomatically
*/
- (BOOL)willLoadImagesAutomatically;
diff --git a/WebKit/WebView.subproj/WebResourceLoadDelegate.h b/WebKit/WebView.subproj/WebResourceLoadDelegate.h
index 54c44d1..a989363 100644
--- a/WebKit/WebView.subproj/WebResourceLoadDelegate.h
+++ b/WebKit/WebView.subproj/WebResourceLoadDelegate.h
@@ -15,74 +15,74 @@
that a resource is about to be loaded, data has been received for a resource,
an error has been received for a resource, and completion of a resource load.
Implementors are also given the opportunity to mutate requests before they are sent.
- The various progrss methods of this protocol all receive an identifier as the
+ The various progress methods of this protocol all receive an identifier as the
parameter. This identifier can be used to track messages associated with a single
resource. For example, a single resource may generate multiple
- resource:willSendRequest:fromDataSource messages as it's URL is redirected.
+ resource:willSendRequest:fromDataSource: messages as it's URL is redirected.
*/
@protocol WebResourceLoadDelegate <NSObject>
/*!
- @method provideIdentifierForInitialRequest:
+ @method identifierForInitialRequest:fromDataSource:
@discussion An implementor of WebResourceLoadDelegate should provide an identifier
that can be used to track the load of a single resource. This identifier will be
- passed as the first argument for all of the other WebResourceLoadDelegate. The
+ passed as the first argument for all of the other WebResourceLoadDelegate methods. The
identifier is useful to track changes to a resources request, which will be
provided by one or more calls to resource:willSendRequest:fromDataSource:.
- @result A identifier that will be passed back to the implementor for each callback.
+ @result An identifier that will be passed back to the implementor for each callback.
The identifier will be retained.
*/
- identifierForInitialRequest: (WebResourceRequest *)request fromDataSource: (WebDataSource *)dataSource;
/*!
- @method resourceRequest:willSendRequest:fromDataSource:
- @discussion This message is sent before a load is initiated. The request may be modified
- as necessary by the receiver.
- @param identifier An identifier that can be used to track the progress of a resource load across
- multiple call backs.
- @param request The request about to be sent.
- @param dataSource The dataSource that initiated the load.
- @result Returns the request, which may be mutated by the implementor, although typically
- will be request.
+ @method resource:willSendRequest:fromDataSource:
+ @discussion This message is sent before a load is initiated. The request may be modified
+ as necessary by the receiver.
+ @param identifier An identifier that can be used to track the progress of a resource load across
+ multiple call backs.
+ @param request The request about to be sent.
+ @param dataSource The dataSource that initiated the load.
+ @result Returns the request, which may be mutated by the implementor, although typically
+ will be request.
*/
-(WebResourceRequest *)resource:identifier willSendRequest: (WebResourceRequest *)request fromDataSource:(WebDataSource *)dataSource;
/*!
- @method resourceRequest:didReceiveResponse:fromDataSource:
- @discussion This message is sent after a response has been received for this load.
- @param identifier An identifier that can be used to track the progress of a resource load across
- multiple call backs.
- @param response The response for the request.
- @param dataSource The dataSource that initiated the load.
+ @method resource:didReceiveResponse:fromDataSource:
+ @discussion This message is sent after a response has been received for this load.
+ @param identifier An identifier that can be used to track the progress of a resource load across
+ multiple call backs.
+ @param response The response for the request.
+ @param dataSource The dataSource that initiated the load.
*/
-(void)resource:identifier didReceiveResponse: (WebResourceResponse *)response fromDataSource:(WebDataSource *)dataSource;
/*!
- @method resourceIdentifier:didReceiveContentLength:fromDataSource:
- @discussion Multiple of these messages may be sent as data arrives.
- @param identifier An identifier that can be used to track the progress of a resource load across
- multiple call backs.
- @param length The amount of new data received. This is not the total amount, just the new amount received.
- @param dataSource The dataSource that initiated the load.
+ @method resource:didReceiveContentLength:fromDataSource:
+ @discussion Multiple of these messages may be sent as data arrives.
+ @param identifier An identifier that can be used to track the progress of a resource load across
+ multiple call backs.
+ @param length The amount of new data received. This is not the total amount, just the new amount received.
+ @param dataSource The dataSource that initiated the load.
*/
-(void)resource:identifier didReceiveContentLength: (unsigned)length fromDataSource:(WebDataSource *)dataSource;
/*!
- @method resourceRequest: didFinishLoadingFromDataSource:
- @discussion This message is sent after a load has successfully completed.
- @param identifier An identifier that can be used to track the progress of a resource load across
- multiple call backs.
- @param dataSource The dataSource that initiated the load.
+ @method resource:didFinishLoadingFromDataSource:
+ @discussion This message is sent after a load has successfully completed.
+ @param identifier An identifier that can be used to track the progress of a resource load across
+ multiple call backs.
+ @param dataSource The dataSource that initiated the load.
*/
-(void)resource:identifier didFinishLoadingFromDataSource:(WebDataSource *)dataSource;
/*!
- @method resourceRequest:didFailLoadingWithError:fromDataSource:
- @discussion This message is sent after a load has successfully completed.
- @param identifier An identifier that can be used to track the progress of a resource load across
- multiple call backs.
- @param error The error associated with this load.
- @param dataSource The dataSource that initiated the load.
+ @method resource:didFailLoadingWithError:fromDataSource:
+ @discussion This message is sent after a load has failed to load due to an error.
+ @param identifier An identifier that can be used to track the progress of a resource load across
+ multiple call backs.
+ @param error The error associated with this load.
+ @param dataSource The dataSource that initiated the load.
*/
-(void)resource:identifier didFailLoadingWithError:(WebError *)error fromDataSource:(WebDataSource *)dataSource;
@@ -99,9 +99,10 @@
/*!
@class WebResourceLoadDelegate
@discussion The WebResourceLoadDelegate class responds to all WebResourceLoadDelegate protocol
- methods by doing nothing, except for resourceRequest:willSendRequest:fromDataSource:, which
- will return the newRequest. It's provided for the convenience of clients who only want
- to implement some of the above methods and ignore others.
+ methods by doing nothing, except for identifierForInitialRequest:fromDataSource: and
+ resource:willSendRequest:fromDataSource:, which return a new NSObject and the
+ passed-in request, respectively. This class is provided for the convenience of clients who only want
+ to implement some of the WebResourceLoadDelegate protocol methods and ignore others.
*/
@interface WebResourceLoadDelegate : NSObject <WebResourceLoadDelegate>
{
diff --git a/WebKit/WebView.subproj/WebUIDelegate.h b/WebKit/WebView.subproj/WebUIDelegate.h
index e18027b..cd51488 100644
--- a/WebKit/WebView.subproj/WebUIDelegate.h
+++ b/WebKit/WebView.subproj/WebUIDelegate.h
@@ -32,7 +32,7 @@
@method showWindow
@abstract Show the window that contains the top level view of the controller,
ordering it frontmost.
- @discussion This will only be called just after createWindowWithURL:referrer:
+ @discussion This will only be called just after createWindowWithRequest:
is used to create a new window.
*/
- (void)showWindow;
@@ -41,7 +41,7 @@
@method showWindowBehindFrontmost
@abstract Show the window that contains the top level view of the controller,
ordering it behind the main window.
- @discussion This will only be called just after createWindowWithURL:referrer:
+ @discussion This will only be called just after createWindowWithRequest:
is used to create a new window.
*/
- (void)showWindowBehindFrontmost;
@@ -64,7 +64,7 @@
@method mouseDidMoveOverElement:modifierFlags:
@abstract Update the window's feedback for mousing over links to reflect a new item the mouse is over
or new modifier flags.
- @param elementInformation Dictionary that describes the clicked element the mouse is over, or nil.
+ @param elementInformation Dictionary that describes the element that the mouse is over, or nil.
@param modifierFlags The modifier flags as in NSEvent.
*/
- (void)mouseDidMoveOverElement:(NSDictionary *)elementInformation modifierFlags:(unsigned int)modifierFlags;
@@ -72,7 +72,7 @@
/*!
@method areToolbarsVisible
@abstract Determine whether the window's toolbars are currently visible
- @discussion This method should return true if the window has any
+ @discussion This method should return YES if the window has any
toolbars that are currently on, besides the status bar. If the app
has more than one toolbar per window, for example a regular
command toolbar and a favorites bar, it should return YES from
diff --git a/WebKit/WebView.subproj/WebView.h b/WebKit/WebView.subproj/WebView.h
index 75915a1..fd666b5 100644
--- a/WebKit/WebView.subproj/WebView.h
+++ b/WebKit/WebView.subproj/WebView.h
@@ -34,7 +34,7 @@ extern NSString *WebElementImageKey; // NSImage of the image element
extern NSString *WebElementImageRectKey; // NSValue of an NSRect, the rect of the image element
extern NSString *WebElementImageURLKey; // NSURL of the image element
extern NSString *WebElementIsSelectedTextKey; // NSNumber of BOOL indicating whether the element is selected text or not
-extern NSString *WebElementLinkURLKey; // NSURL if the element is within an anchor
+extern NSString *WebElementLinkURLKey; // NSURL of the link if the element is within an anchor
extern NSString *WebElementLinkTargetFrameKey; // NSString of the target of the anchor
extern NSString *WebElementLinkTitleKey; // NSString of the title of the anchor
extern NSString *WebElementLinkLabelKey; // NSString of the text within the anchor
@@ -103,10 +103,8 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@method initWithView:controllerSetName:
@abstract The designated initializer for WebController.
@discussion Initialize a WebController with the supplied parameters. This method
- will create a main WebFrame with the view and datasource. The frame will be
- named "_top".
+ will create a main WebFrame with the view. The frame will be named "_top".
@param view The main view to be associated with the controller. May be nil.
- @param dataSource The main datasource to be associated with the controller. May be nil.
@param name The name of the controller set to which this controller will be added. May be nil.
@result Returns an initialized WebController.
*/
@@ -121,14 +119,15 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method windowOperationsDelegate
- @result Return the controller's WebWindowOperationsDelegate.
+ @abstract Return the controller's WebWindowOperationsDelegate.
+ @result The controller's WebWindowOperationsDelegate.
*/
- (id<WebWindowOperationsDelegate>)windowOperationsDelegate;
/*!
@method setResourceLoadDelegate:
- @abstract Set the controller's WebResourceLoadDelegate.
- @param delegate The WebResourceLoadDelegate to set as the delegate.
+ @abstract Set the controller's WebResourceLoadDelegate load delegate.
+ @param delegate The WebResourceLoadDelegate to set as the load delegate.
*/
- (void)setResourceLoadDelegate: (id<WebResourceLoadDelegate>)delegate;
@@ -147,20 +146,22 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method downloadDelegate
- @result Return the controller's WebResourceLoadDelegate download delegate.
+ @abstract Return the controller's WebResourceLoadDelegate download delegate.
+ @result The controller's WebResourceLoadDelegate download delegate.
*/
- (id<WebResourceLoadDelegate>)downloadDelegate;
/*!
@method setContextMenuDelegate:
- @abstract Set the controller's WebContextMenuDelegate download delegate.
- @param delegate The WebContextMenuDelegate to set as the download delegate.
+ @abstract Set the controller's WebContextMenuDelegate.
+ @param delegate The WebContextMenuDelegate to set as the delegate.
*/
- (void)setContextMenuDelegate: (id<WebContextMenuDelegate>)delegate;
/*!
@method contextMenuDelegate
- @result Return the controller's WebContextMenuDelegate.
+ @abstract Return the controller's WebContextMenuDelegate.
+ @result The controller's WebContextMenuDelegate.
*/
- (id<WebContextMenuDelegate>)contextMenuDelegate;
@@ -173,7 +174,8 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method locationChangeDelegate
- @result Return the controller's WebLocationChangeDelegate.
+ @abstract Return the controller's WebLocationChangeDelegate delegate.
+ @result The controller's WebLocationChangeDelegate delegate.
*/
- (id <WebLocationChangeDelegate>)locationChangeDelegate;
@@ -186,7 +188,8 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method policyDelegate
- @result Return the controller's WebControllerPolicyDelegate.
+ @abstract Return the controller's WebControllerPolicyDelegate.
+ @result The controller's WebControllerPolicyDelegate.
*/
- (id<WebControllerPolicyDelegate>)policyDelegate;
@@ -227,34 +230,35 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method setUseBackForwardList:
@abstract Enable or disable the use of a backforward list for this controller.
- @param flag turns use of the back forward list on or off
+ @param flag Turns use of the back forward list on or off
*/
- (void)setUsesBackForwardList: (BOOL)flag;
/*!
@method useBackForwardList
- @result Returns YES if a backforward list is being used by this controller, NO otherwise.
+ @result Returns whether a backforward list is being used by this controller.
+ @result YES if a backforward list is being used by this controller, NO otherwise.
*/
- (BOOL)usesBackForwardList;
/*!
@method goBack
@abstract Go back to the previous URL in the backforward list.
- @result Returns YES if able to go back in the backforward list, NO otherwise.
+ @result YES if able to go back in the backforward list, NO otherwise.
*/
- (BOOL)goBack;
/*!
@method goForward
@abstract Go forward to the next URL in the backforward list.
- @result Returns YES if able to go forward in the backforward list, NO otherwise.
+ @result YES if able to go forward in the backforward list, NO otherwise.
*/
- (BOOL)goForward;
/*!
@method goBackOrForwardToItem:
@abstract Go back or forward to an item in the backforward list.
- @result Returns YES if able to go to the item, NO otherwise.
+ @result YES if able to go to the item, NO otherwise.
*/
- (BOOL)goBackOrForwardToItem:(WebHistoryItem *)item;
@@ -267,7 +271,7 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
/*!
@method textSizeMultiplier
- @result Returns the text size multipler.
+ @result The text size multipler.
*/
- (float)textSizeMultiplier;
@@ -276,22 +280,22 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@abstract Set the application name.
@discussion This name will be used in user-agent strings
that are chosen for best results in rendering web pages.
- @param applicationName the application name
+ @param applicationName The application name
*/
- (void)setApplicationNameForUserAgent:(NSString *)applicationName;
/*!
@method applicationNameForUserAgent
- @result Returns the name of the application as used in the user-agent string.
+ @result The name of the application as used in the user-agent string.
*/
- (NSString *)applicationNameForUserAgent;
/*!
- @method setUserAgent:
+ @method setCustomUserAgent:
@abstract Set the user agent.
@discussion Setting this means that the controller should use this user-agent string
instead of constructing a user-agent string for each URL.
- @param userAgentString the user agent description
+ @param userAgentString The user agent description
*/
- (void)setCustomUserAgent:(NSString *)userAgentString;
@@ -300,7 +304,6 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@abstract Reset the user agent.
@discussion Causes the controller to construct the user-agent string for each URL
for best results rendering web pages.
- @param userAgentString the user agent description
*/
- (void)resetUserAgent;
@@ -308,13 +311,13 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@method hasCustomUserAgent
@abstract Determine whether or not a custom user-agent string is in use.
@discussion It's an error to call customUserAgent if hasCustomUserAgent is NO.
- @result Returns YES if a custom encoding has been set, NO otherwise.
+ @result YES if a custom user agent has been set, NO otherwise.
*/
- (BOOL)hasCustomUserAgent;
/*!
@method customUserAgent
- @result customUserAgent Returns the custom user-agent string. Should only be called
+ @result The custom user-agent string. Should only be called
if hasCustomUserAgent returns YES.
*/
- (NSString *)customUserAgent;
@@ -323,14 +326,14 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@method userAgentForURL:
@abstract Get the appropriate user-agent string for a particular URL.
@param URL The URL.
- @result Returns the user-agent string for the supplied URL.
+ @result The user-agent string for the supplied URL.
*/
- (NSString *)userAgentForURL:(NSURL *)URL;
/*!
@method supportsTextEncoding
@abstract Find out if the current web page supports text encodings.
- @result Returns YES if the document view of the current web page can
+ @result YES if the document view of the current web page can
support different text encodings.
*/
- (BOOL)supportsTextEncoding;
@@ -342,7 +345,7 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
what's specified in a web page's header or HTTP response.
The text encoding automatically goes back to the default when the top level frame
changes to a new location.
- @param encoding
+ @param encoding The text encoding to use to display a page.
*/
- (void)setCustomTextEncodingName:(NSString *)encoding;
@@ -356,20 +359,20 @@ extern NSString *WebElementLinkLabelKey; // NSString of the text within the anch
@method hasCustomTextEncoding
@abstract Determine whether or not a custom text encoding is in use.
@discussion It's an error to call customTextEncoding if hasCustomTextEncoding is NO.
- @result Returns YES if a custom encoding has been set, NO otherwise.
+ @result YES if a custom encoding has been set, NO otherwise.
*/
- (BOOL)hasCustomTextEncoding;
/*!
@method customTextEncoding
- @result Returns the custom text encoding.
+ @result The custom text encoding.
*/
- (NSString *)customTextEncodingName;
/*!
@method stringByEvaluatingJavaScriptFromString:
@param script The text of the JavaScript.
- @result Returns the result of the script, converted to a string, or nil for failure.
+ @result The result of the script, converted to a string, or nil for failure.
*/
- (NSString *)stringByEvaluatingJavaScriptFromString:(NSString *)script;
diff --git a/WebKit/WebView.subproj/WebWindowOperationsDelegate.h b/WebKit/WebView.subproj/WebWindowOperationsDelegate.h
index e18027b..cd51488 100644
--- a/WebKit/WebView.subproj/WebWindowOperationsDelegate.h
+++ b/WebKit/WebView.subproj/WebWindowOperationsDelegate.h
@@ -32,7 +32,7 @@
@method showWindow
@abstract Show the window that contains the top level view of the controller,
ordering it frontmost.
- @discussion This will only be called just after createWindowWithURL:referrer:
+ @discussion This will only be called just after createWindowWithRequest:
is used to create a new window.
*/
- (void)showWindow;
@@ -41,7 +41,7 @@
@method showWindowBehindFrontmost
@abstract Show the window that contains the top level view of the controller,
ordering it behind the main window.
- @discussion This will only be called just after createWindowWithURL:referrer:
+ @discussion This will only be called just after createWindowWithRequest:
is used to create a new window.
*/
- (void)showWindowBehindFrontmost;
@@ -64,7 +64,7 @@
@method mouseDidMoveOverElement:modifierFlags:
@abstract Update the window's feedback for mousing over links to reflect a new item the mouse is over
or new modifier flags.
- @param elementInformation Dictionary that describes the clicked element the mouse is over, or nil.
+ @param elementInformation Dictionary that describes the element that the mouse is over, or nil.
@param modifierFlags The modifier flags as in NSEvent.
*/
- (void)mouseDidMoveOverElement:(NSDictionary *)elementInformation modifierFlags:(unsigned int)modifierFlags;
@@ -72,7 +72,7 @@
/*!
@method areToolbarsVisible
@abstract Determine whether the window's toolbars are currently visible
- @discussion This method should return true if the window has any
+ @discussion This method should return YES if the window has any
toolbars that are currently on, besides the status bar. If the app
has more than one toolbar per window, for example a regular
command toolbar and a favorites bar, it should return YES from
--
WebKit Debian packaging
More information about the Pkg-webkit-commits
mailing list