Title: [207934] trunk/Source/WebKit/mac
Revision
207934
Author
m...@apple.com
Date
2016-10-26 22:17:34 -0700 (Wed, 26 Oct 2016)

Log Message

[Xcode] WebKit fails to build when CLANG_WARN_DOCUMENTATION_COMMENTS is enabled
https://bugs.webkit.org/show_bug.cgi?id=164048

Reviewed by Tim Horton.

* Configurations/Base.xcconfig: Enabled CLANG_WARN_DOCUMENTATION_COMMENTS.
* Configurations/WebKitLegacy.xcconfig: Made the compiler treat the icu headers as system
  headers.

* History/WebBackForwardList.h: Fixed parameter name in @param entry.
* Misc/WebDownload.h: Removed empty entries.
* Misc/WebIconDatabase.h: Remove incorrect @param entries.
* Misc/WebQuotaManager.h: Added missing parameter names in @param entries.
* WebView/WebFrameLoadDelegate.h: Corrected parameter names in @param entries.
* WebView/WebFrameViewPrivate.h: Changed incorrect @result to @abstract.
* WebView/WebPolicyDelegate.h: Fixed parameter name and removed incorrect @param entries.
* WebView/WebPreferences.h: Changed @method to @property in a couple of places.
* WebView/WebResourceLoadDelegate.h: Fixed parameter names.
* WebView/WebUIDelegate.h: Filled in two empty @param entries. Added missing parameter name,
  Fixed a typo and removed empty @discussion entry. Fixed some parameter names.
* WebView/WebUIDelegatePrivate.h: Fixed parameter names.
* WebView/WebView.h: Changed @method to @property in a couple of places.
* WebView/WebViewPrivate.h: Fixed parameter names, changed incorrect @result to @abstract.

Modified Paths

Diff

Modified: trunk/Source/WebKit/mac/ChangeLog (207933 => 207934)


--- trunk/Source/WebKit/mac/ChangeLog	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/ChangeLog	2016-10-27 05:17:34 UTC (rev 207934)
@@ -1,3 +1,29 @@
+2016-10-26  Dan Bernstein  <m...@apple.com>
+
+        [Xcode] WebKit fails to build when CLANG_WARN_DOCUMENTATION_COMMENTS is enabled
+        https://bugs.webkit.org/show_bug.cgi?id=164048
+
+        Reviewed by Tim Horton.
+
+        * Configurations/Base.xcconfig: Enabled CLANG_WARN_DOCUMENTATION_COMMENTS.
+        * Configurations/WebKitLegacy.xcconfig: Made the compiler treat the icu headers as system
+          headers.
+
+        * History/WebBackForwardList.h: Fixed parameter name in @param entry.
+        * Misc/WebDownload.h: Removed empty entries.
+        * Misc/WebIconDatabase.h: Remove incorrect @param entries.
+        * Misc/WebQuotaManager.h: Added missing parameter names in @param entries.
+        * WebView/WebFrameLoadDelegate.h: Corrected parameter names in @param entries.
+        * WebView/WebFrameViewPrivate.h: Changed incorrect @result to @abstract.
+        * WebView/WebPolicyDelegate.h: Fixed parameter name and removed incorrect @param entries.
+        * WebView/WebPreferences.h: Changed @method to @property in a couple of places.
+        * WebView/WebResourceLoadDelegate.h: Fixed parameter names.
+        * WebView/WebUIDelegate.h: Filled in two empty @param entries. Added missing parameter name,
+          Fixed a typo and removed empty @discussion entry. Fixed some parameter names.
+        * WebView/WebUIDelegatePrivate.h: Fixed parameter names.
+        * WebView/WebView.h: Changed @method to @property in a couple of places.
+        * WebView/WebViewPrivate.h: Fixed parameter names, changed incorrect @result to @abstract.
+
 2016-10-26  Brian Burg  <bb...@apple.com>
 
         Web Inspector: remove unused bool return value from FrontendChannel::sendMessageToFrontend

Modified: trunk/Source/WebKit/mac/Configurations/Base.xcconfig (207933 => 207934)


--- trunk/Source/WebKit/mac/Configurations/Base.xcconfig	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/Configurations/Base.xcconfig	2016-10-27 05:17:34 UTC (rev 207934)
@@ -69,6 +69,7 @@
 GCC_WARN_UNINITIALIZED_AUTOS = YES;
 GCC_WARN_UNUSED_FUNCTION = YES;
 GCC_WARN_UNUSED_VARIABLE = YES;
+CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
 OTHER_MIGFLAGS = -F$(BUILT_PRODUCTS_DIR);
 PREBINDING = NO;
 WARNING_CFLAGS = -Wall -Wextra -Wchar-subscripts -Wextra-tokens -Wformat-security -Winit-self -Wmissing-format-attribute -Wmissing-noreturn -Wno-unused-parameter -Wpacked -Wpointer-arith -Wredundant-decls -Wundef -Wwrite-strings -Wexit-time-destructors -Wglobal-constructors -Wtautological-compare -Wimplicit-fallthrough;

Modified: trunk/Source/WebKit/mac/Configurations/WebKitLegacy.xcconfig (207933 => 207934)


--- trunk/Source/WebKit/mac/Configurations/WebKitLegacy.xcconfig	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/Configurations/WebKitLegacy.xcconfig	2016-10-27 05:17:34 UTC (rev 207934)
@@ -51,7 +51,7 @@
 FRAMEWORK_SEARCH_PATHS_ios_Production = $(PRODUCTION_FRAMEWORKS_DIR);
 FRAMEWORK_SEARCH_PATHS[sdk=macosx*] = $(WK_QUOTED_OVERRIDE_FRAMEWORKS_DIR) "$(UMBRELLA_FRAMEWORKS_DIR)" $(inherited);
 
-OTHER_CFLAGS[sdk=macosx*] = $(OTHER_CFLAGS) -iframework $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/Frameworks/ApplicationServices.framework/Frameworks -iframework $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/Frameworks/Carbon.framework/Frameworks -iframework $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/Frameworks/Quartz.framework/Frameworks -iframework $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/Frameworks/CoreServices.framework/Frameworks -iframework $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/PrivateFrameworks;
+OTHER_CFLAGS[sdk=macosx*] = $(OTHER_CFLAGS) -iframework $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/Frameworks/ApplicationServices.framework/Frameworks -iframework $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/Frameworks/Carbon.framework/Frameworks -iframework $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/Frameworks/Quartz.framework/Frameworks -iframework $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/Frameworks/CoreServices.framework/Frameworks -iframework $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/PrivateFrameworks -isystem "$(WEBCORE_PRIVATE_HEADERS_DIR)/icu";
 OTHER_CPLUSPLUSFLAGS = $(OTHER_CFLAGS);
 
 GCC_PREFIX_HEADER = mac/WebKitPrefix.h;
@@ -58,7 +58,7 @@
 GCC_PREPROCESSOR_DEFINITIONS = $(DEBUG_DEFINES) $(FEATURE_DEFINES) FRAMEWORK_NAME=WebKitLegacy $(inherited);
 
 WEBKITADDITIONS_HEADER_SEARCH_PATHS = $(BUILT_PRODUCTS_DIR)/usr/local/include/WebKitAdditions $(SDKROOT)/usr/local/include/WebKitAdditions;
-HEADER_SEARCH_PATHS = $(WEBKITSYSTEMINTERFACE_STATIC_LIBRARY_HEADERS_FOLDER_PATH) "$(WEBCORE_PRIVATE_HEADERS_DIR)/ForwardingHeaders" "$(WEBCORE_PRIVATE_HEADERS_DIR)/icu" "$(BUILT_PRODUCTS_DIR)/DerivedSources/WebKitLegacy" "$(BUILT_PRODUCTS_DIR)/usr/local/include" $(WEBKITADDITIONS_HEADER_SEARCH_PATHS) $(HEADER_SEARCH_PATHS);
+HEADER_SEARCH_PATHS = $(WEBKITSYSTEMINTERFACE_STATIC_LIBRARY_HEADERS_FOLDER_PATH) "$(WEBCORE_PRIVATE_HEADERS_DIR)/ForwardingHeaders" "$(BUILT_PRODUCTS_DIR)/DerivedSources/WebKitLegacy" "$(BUILT_PRODUCTS_DIR)/usr/local/include" $(WEBKITADDITIONS_HEADER_SEARCH_PATHS) $(HEADER_SEARCH_PATHS);
 INFOPLIST_FILE = mac/Info.plist;
 INSTALL_PATH = $(SYSTEM_LIBRARY_DIR)/PrivateFrameworks;
 INSTALL_PATH[sdk=macosx*] = $(WEBKIT_LEGACY_FRAMEWORKS_DIR);

Modified: trunk/Source/WebKit/mac/History/WebBackForwardList.h (207933 => 207934)


--- trunk/Source/WebKit/mac/History/WebBackForwardList.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/History/WebBackForwardList.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -48,7 +48,7 @@
 /*!
     @method addItem:
     @abstract Adds an entry to the list.
-    @param entry The entry to add.
+    @param item 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

Modified: trunk/Source/WebKit/mac/Misc/WebDownload.h (207933 => 207934)


--- trunk/Source/WebKit/mac/Misc/WebDownload.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/Misc/WebDownload.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -74,9 +74,6 @@
 
 /*!
     @method downloadWindowForAuthenticationSheet:
-    @abstract
-    @param
-    @result
 */
 - (NSWindow *)downloadWindowForAuthenticationSheet:(WebDownload *)download;
 

Modified: trunk/Source/WebKit/mac/Misc/WebIconDatabase.h (207933 => 207934)


--- trunk/Source/WebKit/mac/Misc/WebIconDatabase.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/Misc/WebIconDatabase.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -82,8 +82,6 @@
 /*!
     @method iconForURL:withSize:
     @discussion Calls iconForURL:withSize:cache: with YES for cache.
-    @param URL
-    @param size
 */
 - (NSImage *)iconForURL:(NSString *)URL withSize:(NSSize)size;
 
@@ -92,8 +90,6 @@
     @discussion Returns an icon for a web site URL from memory or disk. nil if none is found.
     Usually called by a UI element to determine if a site URL has an associated icon.
     Often called by the observer of WebIconChangedNotification after the notification is sent.
-    @param URL
-    @param size
     @param cache If yes, caches the returned image in memory if not already cached
 */
 - (NSImage *)iconForURL:(NSString *)URL withSize:(NSSize)size cache:(BOOL)cache;
@@ -102,7 +98,6 @@
 /*!
     @method iconURLForURL:withSize:cache:
     @discussion Returns an icon URL for a web site URL from memory or disk. nil if none is found.
-    @param URL
 */
 - (NSString *)iconURLForURL:(NSString *)URL;
 
@@ -109,7 +104,6 @@
 #if !TARGET_OS_IPHONE
 /*!
     @method defaultIconWithSize:
-    @param size
 */
 - (NSImage *)defaultIconWithSize:(NSSize)size;
 - (NSImage *)defaultIconForURL:(NSString *)URL withSize:(NSSize)size;
@@ -118,7 +112,6 @@
 /*!
     @method retainIconForURL:
     @abstract Increments the retain count of the icon.
-    @param URL
 */
 - (void)retainIconForURL:(NSString *)URL;
 
@@ -125,7 +118,6 @@
 /*!
     @method releaseIconForURL:
     @abstract Decrements the retain count of the icon.
-    @param URL
 */
 - (void)releaseIconForURL:(NSString *)URL;
 

Modified: trunk/Source/WebKit/mac/Misc/WebQuotaManager.h (207933 => 207934)


--- trunk/Source/WebKit/mac/Misc/WebQuotaManager.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/Misc/WebQuotaManager.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -33,7 +33,7 @@
 
 /*!
     @method initWithOrigin:
-    @param The security origin this will manage.
+    @param origin The security origin this will manage.
     @result A new WebQuotaManager object.
 */
 - (id)initWithOrigin:(WebSecurityOrigin *)origin;
@@ -58,7 +58,7 @@
 
 /*!
     @method setQuota:
-    @param Sets a new quota, in bytes, on this security origin.
+    @param quota a new quota, in bytes, to set on this security origin.
 */
 - (void)setQuota:(unsigned long long)quota;
 

Modified: trunk/Source/WebKit/mac/WebView/WebFrameLoadDelegate.h (207933 => 207934)


--- trunk/Source/WebKit/mac/WebView/WebFrameLoadDelegate.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/WebView/WebFrameLoadDelegate.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -57,7 +57,7 @@
 /*!
     @method webView:didStartProvisionalLoadForFrame:
     @abstract Notifies the delegate that the provisional load of a frame has started
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param frame The frame for which the provisional load has started
     @discussion This method is called after the provisional data source of a frame
     has started to load.
@@ -67,7 +67,7 @@
 /*!
     @method webView:didReceiveServerRedirectForProvisionalLoadForFrame:
     @abstract Notifies the delegate that a server redirect occurred during the provisional load
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param frame The frame for which the redirect occurred
 */
 - (void)webView:(WebView *)sender didReceiveServerRedirectForProvisionalLoadForFrame:(WebFrame *)frame;
@@ -75,7 +75,7 @@
 /*!
     @method webView:didFailProvisionalLoadWithError:forFrame:
     @abstract Notifies the delegate that the provisional load has failed
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param error The error that occurred
     @param frame The frame for which the error occurred
     @discussion This method is called after the provisional data source has failed to load.
@@ -86,7 +86,7 @@
 /*!
     @method webView:didCommitLoadForFrame:
     @abstract Notifies the delegate that the load has changed from provisional to committed
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param frame The frame for which the load has committed
     @discussion This method is called after the provisional data source has become the
     committed data source.
@@ -101,7 +101,7 @@
 /*!
     @method webView:didReceiveTitle:forFrame:
     @abstract Notifies the delegate that the page title for a frame has been received
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param title The new page title
     @param frame The frame for which the title has been received
     @discussion The title may update during loading; clients should be prepared for this.
@@ -122,7 +122,7 @@
 /*!
     @method webView:didFinishLoadForFrame:
     @abstract Notifies the delegate that the committed load of a frame has completed
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param frame The frame that finished loading
     @discussion This method is called after the committed data source of a frame has successfully loaded
     and will only be called when all subresources such as images and stylesheets are done loading.
@@ -133,7 +133,7 @@
 /*!
     @method webView:didFailLoadWithError:forFrame:
     @abstract Notifies the delegate that the committed load of a frame has failed
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param error The error that occurred
     @param frame The frame that failed to load
     @discussion This method is called after a data source has committed but failed to completely load.
@@ -143,7 +143,7 @@
 /*!
     @method webView:didChangeLocationWithinPageForFrame:
     @abstract Notifies the delegate that the scroll position in a frame has changed
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param frame The frame that scrolled
     @discussion This method is called when anchors within a page have been clicked.
 */
@@ -152,7 +152,7 @@
 /*!
     @method webView:willPerformClientRedirectToURL:delay:fireDate:forFrame:
     @abstract Notifies the delegate that a frame will perform a client-side redirect
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param URL The URL to be redirected to
     @param seconds Seconds in which the redirect will happen
     @param date The fire date
@@ -165,7 +165,7 @@
 /*!
     @method webView:didCancelClientRedirectForFrame:
     @abstract Notifies the delegate that a pending client-side redirect has been cancelled
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param frame The frame for which the pending redirect was cancelled
     @discussion A client-side redirect can be cancelled if a frame changes location before the timeout.
 */
@@ -174,7 +174,7 @@
 /*!
     @method webView:willCloseFrame:
     @abstract Notifies the delegate that a frame will be closed
-    @param webView The WebView sending the message
+    @param sender The WebView sending the message
     @param frame The frame that will be closed
     @discussion This method is called right before WebKit is done with the frame
     and the objects that it contains.

Modified: trunk/Source/WebKit/mac/WebView/WebFrameViewPrivate.h (207933 => 207934)


--- trunk/Source/WebKit/mac/WebView/WebFrameViewPrivate.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/WebView/WebFrameViewPrivate.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -79,7 +79,7 @@
 #if !TARGET_OS_IPHONE
 /*!
     @method _setCustomScrollViewClass:
-    @result Switches the WebFrameView's scroll view class, this class needs to be a subclass of WebDynamicScrollBarsView.
+    @abstract Switches the WebFrameView's scroll view class, this class needs to be a subclass of WebDynamicScrollBarsView.
     Passing nil will switch back to the default WebDynamicScrollBarsView class.
  */
 - (void)_setCustomScrollViewClass:(Class)scrollViewClass;

Modified: trunk/Source/WebKit/mac/WebView/WebPolicyDelegate.h (207933 => 207934)


--- trunk/Source/WebKit/mac/WebView/WebPolicyDelegate.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/WebView/WebPolicyDelegate.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -161,7 +161,7 @@
     @discussion This method is called to decide what to do with an targetted nagivation that would open a new window.
     @param actionInformation Dictionary that describes the action that triggered this navigation.
     @param request The request for the proposed navigation
-    @param frame The frame in which the navigation is taking place
+    @param frameName The frame in which the navigation is taking place
     @param listener The object to call when the decision is made
     @discussion This method is provided so that modified clicks on a targetted link which
     opens a new frame can prevent the new window from being opened if they decide to
@@ -194,9 +194,7 @@
 /*!
     @method webView:unableToImplementPolicy:error:forURL:inFrame:
     @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 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)webView:(WebView *)webView unableToImplementPolicyWithError:(NSError *)error frame:(WebFrame *)frame;

Modified: trunk/Source/WebKit/mac/WebView/WebPreferences.h (207933 => 207934)


--- trunk/Source/WebKit/mac/WebView/WebPreferences.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/WebView/WebPreferences.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -93,7 +93,7 @@
 - (instancetype)initWithIdentifier:(NSString *)anIdentifier;
 
 /*!
-    @method identifier
+    @property identifier
     @result Returns the identifier for this WebPreferences.
 */
 @property (nonatomic, readonly, copy) NSString *identifier;
@@ -144,7 +144,7 @@
 @property (nonatomic) int minimumFontSize;
 
 /*!
-    @method minimumLogicalFontSize
+    @property minimumLogicalFontSize
 */
 @property (nonatomic) int minimumLogicalFontSize;
 

Modified: trunk/Source/WebKit/mac/WebView/WebResourceLoadDelegate.h (207933 => 207934)


--- trunk/Source/WebKit/mac/WebView/WebResourceLoadDelegate.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/WebView/WebResourceLoadDelegate.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -49,7 +49,7 @@
 
 /*!
     @method webView:identifierForInitialRequest:fromDataSource:
-    @param webView The WebView sending the message.
+    @param sender The WebView sending the message.
     @param request The request about to be sent.
     @param dataSource The datasource that initiated the load.
     @discussion An implementor of WebResourceLoadDelegate should provide an identifier
@@ -66,7 +66,7 @@
     @method webView:resource:willSendRequest:redirectResponse:fromDataSource:
     @discussion This message is sent before a load is initiated.  The request may be modified
     as necessary by the receiver.
-    @param webView The WebView sending the message.
+    @param sender The WebView sending the message.
     @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.
@@ -99,7 +99,7 @@
 /*!
     @method webView:resource:didReceiveResponse:fromDataSource:
     @abstract This message is sent after a response has been received for this load.
-    @param webView The WebView sending the message.
+    @param sender The WebView sending the message.
     @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.
@@ -114,7 +114,7 @@
 /*!
     @method webView:resource:didReceiveContentLength:fromDataSource:
     @discussion Multiple of these messages may be sent as data arrives.
-    @param webView The WebView sending the message.
+    @param sender The WebView sending the message.
     @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.
@@ -125,7 +125,7 @@
 /*!
     @method webView:resource:didFinishLoadingFromDataSource:
     @discussion This message is sent after a load has successfully completed.
-    @param webView The WebView sending the message.
+    @param sender The WebView sending the message.
     @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.
@@ -135,7 +135,7 @@
 /*!
     @method webView:resource:didFailLoadingWithError:fromDataSource:
     @discussion This message is sent after a load has failed to load due to an error.
-    @param webView The WebView sending the message.
+    @param sender The WebView sending the message.
     @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.
@@ -146,7 +146,7 @@
 /*!
     @method webView:plugInFailedWithError:dataSource:
     @discussion Called when a plug-in is not found, fails to load or is not available for some reason.
-    @param webView The WebView sending the message.
+    @param sender The WebView sending the message.
     @param error The plug-in error. In the userInfo dictionary of the error, the object for the
     NSErrorFailingURLKey key is a URL string of the SRC attribute, the object for the WebKitErrorPlugInNameKey
     key is a string of the plug-in's name, the object for the WebKitErrorPlugInPageURLStringKey key is a URL string

Modified: trunk/Source/WebKit/mac/WebView/WebUIDelegate.h (207933 => 207934)


--- trunk/Source/WebKit/mac/WebView/WebUIDelegate.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/WebView/WebUIDelegate.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -125,7 +125,7 @@
 /*!
     @method chooseFilename:
     @abstract Call this method to return a filename from the file open panel.
-    @param fileName
+    @param fileName the path of the selected file
 */
 - (void)chooseFilename:(NSString *)fileName;
 
@@ -132,7 +132,7 @@
 /*!
     @method chooseFilenames:
     @abstract Call this method to return an array of filenames from the file open panel.
-    @param fileNames
+    @param fileNames an array of paths of selected files
 */
 - (void)chooseFilenames:(NSArray *)fileNames WEBKIT_AVAILABLE_MAC(10_6);
 
@@ -220,7 +220,7 @@
 /*!
     @method webViewFocus:
     @abstract Focus the current window (i.e. makeKeyAndOrderFront:).
-    @param The WebView sending the delegate method.
+    @param sender The WebView sending the delegate method.
     @discussion Clients showing multiple views in one window may want to
     also do something to focus the one corresponding to this WebView.
 */
@@ -353,8 +353,7 @@
 /*!
     @method webViewFrame:
     @param sender The WebView sending the delegate method.
-    @abstract REturn the window's frame rect
-    @discussion 
+    @abstract Return the window's frame rect
 */
 - (NSRect)webViewFrame:(WebView *)sender;
 
@@ -387,7 +386,7 @@
     @method webView:runJavaScriptTextInputPanelWithPrompt:defaultText:initiatedByFrame:
     @abstract Display a _javascript_ text input panel.
     @param sender The WebView sending the delegate method.
-    @param message The message to display.
+    @param prompt The message to display.
     @param defaultText The initial text for the text entry area.
     @param frame The WebFrame whose _javascript_ initiated this call.
     @result The typed text if the user hit OK, otherwise nil.
@@ -528,7 +527,7 @@
 /*!
     @method webView:printFrameView:
     @abstract Informs that a WebFrameView needs to be printed
-    @param webView The WebView sending the delegate method
+    @param sender The WebView sending the delegate method
     @param frameView The WebFrameView needing to be printed
     @discussion This method is called when a script or user requests the page to be printed.
     In this method the delegate can prepare the WebFrameView to be printed. Some content that WebKit
@@ -542,7 +541,7 @@
 
 /*!
     @method webViewHeaderHeight:
-    @param webView The WebView sending the delegate method
+    @param sender The WebView sending the delegate method
     @abstract Reserve a height for the printed page header.
     @result The height to reserve for the printed page header, return 0.0 to not reserve any space for a header.
     @discussion The height returned will be used to calculate the rect passed to webView:drawHeaderInRect:.
@@ -551,7 +550,7 @@
 
 /*!
     @method webViewFooterHeight:
-    @param webView The WebView sending the delegate method
+    @param sender The WebView sending the delegate method
     @abstract Reserve a height for the printed page footer.
     @result The height to reserve for the printed page footer, return 0.0 to not reserve any space for a footer.
     @discussion The height returned will be used to calculate the rect passed to webView:drawFooterInRect:.
@@ -560,7 +559,7 @@
 
 /*!
     @method webView:drawHeaderInRect:
-    @param webView The WebView sending the delegate method
+    @param sender The WebView sending the delegate method
     @param rect The NSRect reserved for the header of the page
     @abstract The delegate should draw a header for the sender in the supplied rect.
 */
@@ -568,7 +567,7 @@
 
 /*!
     @method webView:drawFooterInRect:
-    @param webView The WebView sending the delegate method
+    @param sender The WebView sending the delegate method
     @param rect The NSRect reserved for the footer of the page
     @abstract The delegate should draw a footer for the sender in the supplied rect.
 */

Modified: trunk/Source/WebKit/mac/WebView/WebUIDelegatePrivate.h (207933 => 207934)


--- trunk/Source/WebKit/mac/WebView/WebUIDelegatePrivate.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/WebView/WebUIDelegatePrivate.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -247,7 +247,6 @@
 
 /*!
     @method webView:decidePolicyForGeolocationRequestFromOrigin:frame:listener:
-    @abstract 
     @param webView The WebView sending the delegate method.
     @param origin The security origin that would like to use Geolocation.
     @param frame The WebFrame whose _javascript_ initiated this call.
@@ -267,8 +266,8 @@
 /*!
     @method webView:printFrame:
     @abstract Informs that a WebFrame needs to be printed
-    @param webView The WebView sending the delegate method
-    @param frameView The WebFrame needing to be printed
+    @param sender The WebView sending the delegate method
+    @param frame The WebFrame needing to be printed
     @discussion This method is called when a script or user requests the page to be printed.
 */
 - (void)webView:(WebView *)sender printFrame:(WebFrame *)frame;

Modified: trunk/Source/WebKit/mac/WebView/WebView.h (207933 => 207934)


--- trunk/Source/WebKit/mac/WebView/WebView.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/WebView/WebView.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -362,7 +362,7 @@
 @property (nonatomic, copy) NSString *customTextEncodingName;
 
 /*!
-    @method mediaStyle
+    @property mediaStyle
     @abstract The media style for the WebView.
     @discussion The mediaStyle will override the normal value
     of the CSS media property. Setting the value to nil will restore the normal value. The value will be nil unless explicitly set.
@@ -516,7 +516,7 @@
 @property (nonatomic) BOOL drawsBackground;
 
 /*!
-    @method shouldUpdateWhileOffscreen
+    @property shouldUpdateWhileOffscreen
     @abstract Whether the WebView is always updated even when it is not in a window that is currently visible.
     @discussion If set to NO, then whenever the web view is not in a visible window, updates to the web page will not necessarily be rendered in the view.
     However, when the window is made visible, the view will be updated automatically. Not updating while hidden can improve performance. If set to is YES,

Modified: trunk/Source/WebKit/mac/WebView/WebViewPrivate.h (207933 => 207934)


--- trunk/Source/WebKit/mac/WebView/WebViewPrivate.h	2016-10-27 04:54:14 UTC (rev 207933)
+++ trunk/Source/WebKit/mac/WebView/WebViewPrivate.h	2016-10-27 05:17:34 UTC (rev 207934)
@@ -491,7 +491,7 @@
     @discussion Register classes that implement WebDocumentView and WebDocumentRepresentation respectively.
     @param viewClass The WebDocumentView class to use to render data for a given MIME type.
     @param representationClass The WebDocumentRepresentation class to use to represent data of the given MIME type.
-    @param scheme The URL scheme to represent with an object of the given class.
+    @param URLScheme The URL scheme to represent with an object of the given class.
 */
 + (void)_registerViewClass:(Class)viewClass representationClass:(Class)representationClass forURLScheme:(NSString *)URLScheme;
 
@@ -574,7 +574,7 @@
 #if !TARGET_OS_IPHONE
 /*!
     @method setAlwaysShowVerticalScroller:
-    @result Forces the vertical scroller to be visible if flag is YES, otherwise
+    @abstract Forces the vertical scroller to be visible if flag is YES, otherwise
     if flag is NO the scroller with automatically show and hide as needed.
  */
 - (void)setAlwaysShowVerticalScroller:(BOOL)flag;
@@ -587,7 +587,7 @@
 
 /*!
     @method setAlwaysShowHorizontalScroller:
-    @result Forces the horizontal scroller to be visible if flag is YES, otherwise
+    @abstract Forces the horizontal scroller to be visible if flag is YES, otherwise
     if flag is NO the scroller with automatically show and hide as needed.
  */
 - (void)setAlwaysShowHorizontalScroller:(BOOL)flag;
@@ -794,7 +794,7 @@
 
 /*!
     @method setCSSAnimationsSuspended
-    @param paused YES to suspend animations, NO to resume animations.
+    @param suspended YES to suspend animations, NO to resume animations.
     @discussion Suspends or resumes all running animations and transitions in the page.
 */
 - (void)setCSSAnimationsSuspended:(BOOL)suspended;
_______________________________________________
webkit-changes mailing list
webkit-changes@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-changes

Reply via email to