Changeset 207934 in webkit


Ignore:
Timestamp:
Oct 26, 2016 10:17:34 PM (7 years ago)
Author:
mitz@apple.com
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.
Location:
trunk/Source/WebKit/mac
Files:
16 edited

Legend:

Unmodified
Added
Removed

  • trunk/Source/WebKit/mac/ChangeLog

    r207928 r207934  
     12016-10-26  Dan Bernstein  <mitz@apple.com>
     2
     3        [Xcode] WebKit fails to build when CLANG_WARN_DOCUMENTATION_COMMENTS is enabled
     4        https://bugs.webkit.org/show_bug.cgi?id=164048
     5
     6        Reviewed by Tim Horton.
     7
     8        * Configurations/Base.xcconfig: Enabled CLANG_WARN_DOCUMENTATION_COMMENTS.
     9        * Configurations/WebKitLegacy.xcconfig: Made the compiler treat the icu headers as system
     10          headers.
     11
     12        * History/WebBackForwardList.h: Fixed parameter name in @param entry.
     13        * Misc/WebDownload.h: Removed empty entries.
     14        * Misc/WebIconDatabase.h: Remove incorrect @param entries.
     15        * Misc/WebQuotaManager.h: Added missing parameter names in @param entries.
     16        * WebView/WebFrameLoadDelegate.h: Corrected parameter names in @param entries.
     17        * WebView/WebFrameViewPrivate.h: Changed incorrect @result to @abstract.
     18        * WebView/WebPolicyDelegate.h: Fixed parameter name and removed incorrect @param entries.
     19        * WebView/WebPreferences.h: Changed @method to @property in a couple of places.
     20        * WebView/WebResourceLoadDelegate.h: Fixed parameter names.
     21        * WebView/WebUIDelegate.h: Filled in two empty @param entries. Added missing parameter name,
     22          Fixed a typo and removed empty @discussion entry. Fixed some parameter names.
     23        * WebView/WebUIDelegatePrivate.h: Fixed parameter names.
     24        * WebView/WebView.h: Changed @method to @property in a couple of places.
     25        * WebView/WebViewPrivate.h: Fixed parameter names, changed incorrect @result to @abstract.
     26
    1272016-10-26  Brian Burg  <bburg@apple.com>
    228

  • trunk/Source/WebKit/mac/Configurations/Base.xcconfig

    r204526 r207934  
    7070GCC_WARN_UNUSED_FUNCTION = YES;
    7171GCC_WARN_UNUSED_VARIABLE = YES;
     72CLANG_WARN_DOCUMENTATION_COMMENTS = YES;
    7273OTHER_MIGFLAGS = -F$(BUILT_PRODUCTS_DIR);
    7374PREBINDING = NO;

  • trunk/Source/WebKit/mac/Configurations/WebKitLegacy.xcconfig

    r204627 r207934  
    5252FRAMEWORK_SEARCH_PATHS[sdk=macosx*] = $(WK_QUOTED_OVERRIDE_FRAMEWORKS_DIR) "$(UMBRELLA_FRAMEWORKS_DIR)" $(inherited);
    5353
    54 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;
     54OTHER_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";
    5555OTHER_CPLUSPLUSFLAGS = $(OTHER_CFLAGS);
    5656
    … …  
    5959
    6060WEBKITADDITIONS_HEADER_SEARCH_PATHS = $(BUILT_PRODUCTS_DIR)/usr/local/include/WebKitAdditions $(SDKROOT)/usr/local/include/WebKitAdditions;
    61 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);
     61HEADER_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);
    6262INFOPLIST_FILE = mac/Info.plist;
    6363INSTALL_PATH = $(SYSTEM_LIBRARY_DIR)/PrivateFrameworks;

  • trunk/Source/WebKit/mac/History/WebBackForwardList.h

    r177484 r207934  
    4949    @method addItem:
    5050    @abstract Adds an entry to the list.
    51     @param entry The entry to add.
     51    @param item The entry to add.
    5252    @discussion The added entry is inserted immediately after the current entry.
    5353    If the current position in the list is not at the end of the list, elements in the

  • trunk/Source/WebKit/mac/Misc/WebDownload.h

    r194472 r207934  
    7575/*!
    7676    @method downloadWindowForAuthenticationSheet:
    77     @abstract
    78     @param
    79     @result
    8077*/
    8178- (NSWindow *)downloadWindowForAuthenticationSheet:(WebDownload *)download;

  • trunk/Source/WebKit/mac/Misc/WebIconDatabase.h

    r205592 r207934  
    8383    @method iconForURL:withSize:
    8484    @discussion Calls iconForURL:withSize:cache: with YES for cache.
    85     @param URL
    86     @param size
    8785*/
    8886- (NSImage *)iconForURL:(NSString *)URL withSize:(NSSize)size;
    … …  
    9391    Usually called by a UI element to determine if a site URL has an associated icon.
    9492    Often called by the observer of WebIconChangedNotification after the notification is sent.
    95     @param URL
    96     @param size
    9793    @param cache If yes, caches the returned image in memory if not already cached
    9894*/
    … …  
    10399    @method iconURLForURL:withSize:cache:
    104100    @discussion Returns an icon URL for a web site URL from memory or disk. nil if none is found.
    105     @param URL
    106101*/
    107102- (NSString *)iconURLForURL:(NSString *)URL;
    … …  
    110105/*!
    111106    @method defaultIconWithSize:
    112     @param size
    113107*/
    114108- (NSImage *)defaultIconWithSize:(NSSize)size;
    … …  
    119113    @method retainIconForURL:
    120114    @abstract Increments the retain count of the icon.
    121     @param URL
    122115*/
    123116- (void)retainIconForURL:(NSString *)URL;
    … …  
    126119    @method releaseIconForURL:
    127120    @abstract Decrements the retain count of the icon.
    128     @param URL
    129121*/
    130122- (void)releaseIconForURL:(NSString *)URL;

  • trunk/Source/WebKit/mac/Misc/WebQuotaManager.h

    r95901 r207934  
    3434/*!
    3535    @method initWithOrigin:
    36     @param The security origin this will manage.
     36    @param origin The security origin this will manage.
    3737    @result A new WebQuotaManager object.
    3838*/
    … …  
    5959/*!
    6060    @method setQuota:
    61     @param Sets a new quota, in bytes, on this security origin.
     61    @param quota a new quota, in bytes, to set on this security origin.
    6262*/
    6363- (void)setQuota:(unsigned long long)quota;

  • trunk/Source/WebKit/mac/WebView/WebFrameLoadDelegate.h

    r186124 r207934  
    5858    @method webView:didStartProvisionalLoadForFrame:
    5959    @abstract Notifies the delegate that the provisional load of a frame has started
    60     @param webView The WebView sending the message
     60    @param sender The WebView sending the message
    6161    @param frame The frame for which the provisional load has started
    6262    @discussion This method is called after the provisional data source of a frame
    … …  
    6868    @method webView:didReceiveServerRedirectForProvisionalLoadForFrame:
    6969    @abstract Notifies the delegate that a server redirect occurred during the provisional load
    70     @param webView The WebView sending the message
     70    @param sender The WebView sending the message
    7171    @param frame The frame for which the redirect occurred
    7272*/
    … …  
    7676    @method webView:didFailProvisionalLoadWithError:forFrame:
    7777    @abstract Notifies the delegate that the provisional load has failed
    78     @param webView The WebView sending the message
     78    @param sender The WebView sending the message
    7979    @param error The error that occurred
    8080    @param frame The frame for which the error occurred
    … …  
    8787    @method webView:didCommitLoadForFrame:
    8888    @abstract Notifies the delegate that the load has changed from provisional to committed
    89     @param webView The WebView sending the message
     89    @param sender The WebView sending the message
    9090    @param frame The frame for which the load has committed
    9191    @discussion This method is called after the provisional data source has become the
    … …  
    102102    @method webView:didReceiveTitle:forFrame:
    103103    @abstract Notifies the delegate that the page title for a frame has been received
    104     @param webView The WebView sending the message
     104    @param sender The WebView sending the message
    105105    @param title The new page title
    106106    @param frame The frame for which the title has been received
    … …  
    123123    @method webView:didFinishLoadForFrame:
    124124    @abstract Notifies the delegate that the committed load of a frame has completed
    125     @param webView The WebView sending the message
     125    @param sender The WebView sending the message
    126126    @param frame The frame that finished loading
    127127    @discussion This method is called after the committed data source of a frame has successfully loaded
    … …  
    134134    @method webView:didFailLoadWithError:forFrame:
    135135    @abstract Notifies the delegate that the committed load of a frame has failed
    136     @param webView The WebView sending the message
     136    @param sender The WebView sending the message
    137137    @param error The error that occurred
    138138    @param frame The frame that failed to load
    … …  
    144144    @method webView:didChangeLocationWithinPageForFrame:
    145145    @abstract Notifies the delegate that the scroll position in a frame has changed
    146     @param webView The WebView sending the message
     146    @param sender The WebView sending the message
    147147    @param frame The frame that scrolled
    148148    @discussion This method is called when anchors within a page have been clicked.
    … …  
    153153    @method webView:willPerformClientRedirectToURL:delay:fireDate:forFrame:
    154154    @abstract Notifies the delegate that a frame will perform a client-side redirect
    155     @param webView The WebView sending the message
     155    @param sender The WebView sending the message
    156156    @param URL The URL to be redirected to
    157157    @param seconds Seconds in which the redirect will happen
    … …  
    166166    @method webView:didCancelClientRedirectForFrame:
    167167    @abstract Notifies the delegate that a pending client-side redirect has been cancelled
    168     @param webView The WebView sending the message
     168    @param sender The WebView sending the message
    169169    @param frame The frame for which the pending redirect was cancelled
    170170    @discussion A client-side redirect can be cancelled if a frame changes location before the timeout.
    … …  
    175175    @method webView:willCloseFrame:
    176176    @abstract Notifies the delegate that a frame will be closed
    177     @param webView The WebView sending the message
     177    @param sender The WebView sending the message
    178178    @param frame The frame that will be closed
    179179    @discussion This method is called right before WebKit is done with the frame

  • trunk/Source/WebKit/mac/WebView/WebFrameViewPrivate.h

    r168047 r207934  
    8080/*!
    8181    @method _setCustomScrollViewClass:
    82     @result Switches the WebFrameView's scroll view class, this class needs to be a subclass of WebDynamicScrollBarsView.
     82    @abstract Switches the WebFrameView's scroll view class, this class needs to be a subclass of WebDynamicScrollBarsView.
    8383    Passing nil will switch back to the default WebDynamicScrollBarsView class.
    8484 */

  • trunk/Source/WebKit/mac/WebView/WebPolicyDelegate.h

    r186124 r207934  
    162162    @param actionInformation Dictionary that describes the action that triggered this navigation.
    163163    @param request The request for the proposed navigation
    164     @param frame The frame in which the navigation is taking place
     164    @param frameName The frame in which the navigation is taking place
    165165    @param listener The object to call when the decision is made
    166166    @discussion This method is provided so that modified clicks on a targetted link which
    … …  
    195195    @method webView:unableToImplementPolicy:error:forURL:inFrame:
    196196    @discussion Called when a WebPolicy could not be implemented. It is up to the client to display appropriate feedback.
    197     @param policy The policy that could not be implemented.
    198197    @param error The error that caused the policy to not be implemented.
    199     @param URL The URL of the resource for which a particular action was requested but failed.
    200198    @param frame The frame in which the policy could not be implemented.
    201199*/

  • trunk/Source/WebKit/mac/WebView/WebPreferences.h

    r184946 r207934  
    9494
    9595/*!
    96     @method identifier
     96    @property identifier
    9797    @result Returns the identifier for this WebPreferences.
    9898*/
    … …  
    145145
    146146/*!
    147     @method minimumLogicalFontSize
     147    @property minimumLogicalFontSize
    148148*/
    149149@property (nonatomic) int minimumLogicalFontSize;

  • trunk/Source/WebKit/mac/WebView/WebResourceLoadDelegate.h

    r186124 r207934  
    5050/*!
    5151    @method webView:identifierForInitialRequest:fromDataSource:
    52     @param webView The WebView sending the message.
     52    @param sender The WebView sending the message.
    5353    @param request The request about to be sent.
    5454    @param dataSource The datasource that initiated the load.
    … …  
    6767    @discussion This message is sent before a load is initiated.  The request may be modified
    6868    as necessary by the receiver.
    69     @param webView The WebView sending the message.
     69    @param sender The WebView sending the message.
    7070    @param identifier An identifier that can be used to track the progress of a resource load across
    7171    multiple call backs.
    … …  
    100100    @method webView:resource:didReceiveResponse:fromDataSource:
    101101    @abstract This message is sent after a response has been received for this load.
    102     @param webView The WebView sending the message.
     102    @param sender The WebView sending the message.
    103103    @param identifier An identifier that can be used to track the progress of a resource load across
    104104    multiple call backs.
    … …  
    115115    @method webView:resource:didReceiveContentLength:fromDataSource:
    116116    @discussion Multiple of these messages may be sent as data arrives.
    117     @param webView The WebView sending the message.
     117    @param sender The WebView sending the message.
    118118    @param identifier An identifier that can be used to track the progress of a resource load across
    119119    multiple call backs.
    … …  
    126126    @method webView:resource:didFinishLoadingFromDataSource:
    127127    @discussion This message is sent after a load has successfully completed.
    128     @param webView The WebView sending the message.
     128    @param sender The WebView sending the message.
    129129    @param identifier An identifier that can be used to track the progress of a resource load across
    130130    multiple call backs.
    … …  
    136136    @method webView:resource:didFailLoadingWithError:fromDataSource:
    137137    @discussion This message is sent after a load has failed to load due to an error.
    138     @param webView The WebView sending the message.
     138    @param sender The WebView sending the message.
    139139    @param identifier An identifier that can be used to track the progress of a resource load across
    140140    multiple call backs.
    … …  
    147147    @method webView:plugInFailedWithError:dataSource:
    148148    @discussion Called when a plug-in is not found, fails to load or is not available for some reason.
    149     @param webView The WebView sending the message.
     149    @param sender The WebView sending the message.
    150150    @param error The plug-in error. In the userInfo dictionary of the error, the object for the
    151151    NSErrorFailingURLKey key is a URL string of the SRC attribute, the object for the WebKitErrorPlugInNameKey

  • trunk/Source/WebKit/mac/WebView/WebUIDelegate.h

    r186124 r207934  
    126126    @method chooseFilename:
    127127    @abstract Call this method to return a filename from the file open panel.
    128     @param fileName
     128    @param fileName the path of the selected file
    129129*/
    130130- (void)chooseFilename:(NSString *)fileName;
    … …  
    133133    @method chooseFilenames:
    134134    @abstract Call this method to return an array of filenames from the file open panel.
    135     @param fileNames
     135    @param fileNames an array of paths of selected files
    136136*/
    137137- (void)chooseFilenames:(NSArray *)fileNames WEBKIT_AVAILABLE_MAC(10_6);
    … …  
    221221    @method webViewFocus:
    222222    @abstract Focus the current window (i.e. makeKeyAndOrderFront:).
    223     @param The WebView sending the delegate method.
     223    @param sender The WebView sending the delegate method.
    224224    @discussion Clients showing multiple views in one window may want to
    225225    also do something to focus the one corresponding to this WebView.
    … …  
    354354    @method webViewFrame:
    355355    @param sender The WebView sending the delegate method.
    356     @abstract REturn the window's frame rect
    357     @discussion
     356    @abstract Return the window's frame rect
    358357*/
    359358- (NSRect)webViewFrame:(WebView *)sender;
    … …  
    388387    @abstract Display a JavaScript text input panel.
    389388    @param sender The WebView sending the delegate method.
    390     @param message The message to display.
     389    @param prompt The message to display.
    391390    @param defaultText The initial text for the text entry area.
    392391    @param frame The WebFrame whose JavaScript initiated this call.
    … …  
    529528    @method webView:printFrameView:
    530529    @abstract Informs that a WebFrameView needs to be printed
    531     @param webView The WebView sending the delegate method
     530    @param sender The WebView sending the delegate method
    532531    @param frameView The WebFrameView needing to be printed
    533532    @discussion This method is called when a script or user requests the page to be printed.
    … …  
    543542/*!
    544543    @method webViewHeaderHeight:
    545     @param webView The WebView sending the delegate method
     544    @param sender The WebView sending the delegate method
    546545    @abstract Reserve a height for the printed page header.
    547546    @result The height to reserve for the printed page header, return 0.0 to not reserve any space for a header.
    … …  
    552551/*!
    553552    @method webViewFooterHeight:
    554     @param webView The WebView sending the delegate method
     553    @param sender The WebView sending the delegate method
    555554    @abstract Reserve a height for the printed page footer.
    556555    @result The height to reserve for the printed page footer, return 0.0 to not reserve any space for a footer.
    … …  
    561560/*!
    562561    @method webView:drawHeaderInRect:
    563     @param webView The WebView sending the delegate method
     562    @param sender The WebView sending the delegate method
    564563    @param rect The NSRect reserved for the header of the page
    565564    @abstract The delegate should draw a header for the sender in the supplied rect.
    … …  
    569568/*!
    570569    @method webView:drawFooterInRect:
    571     @param webView The WebView sending the delegate method
     570    @param sender The WebView sending the delegate method
    572571    @param rect The NSRect reserved for the footer of the page
    573572    @abstract The delegate should draw a footer for the sender in the supplied rect.

  • trunk/Source/WebKit/mac/WebView/WebUIDelegatePrivate.h

    r198900 r207934  
    248248/*!
    249249    @method webView:decidePolicyForGeolocationRequestFromOrigin:frame:listener:
    250     @abstract
    251250    @param webView The WebView sending the delegate method.
    252251    @param origin The security origin that would like to use Geolocation.
    … …  
    268267    @method webView:printFrame:
    269268    @abstract Informs that a WebFrame needs to be printed
    270     @param webView The WebView sending the delegate method
    271     @param frameView The WebFrame needing to be printed
     269    @param sender The WebView sending the delegate method
     270    @param frame The WebFrame needing to be printed
    272271    @discussion This method is called when a script or user requests the page to be printed.
    273272*/

  • trunk/Source/WebKit/mac/WebView/WebView.h

    r191213 r207934  
    363363
    364364/*!
    365     @method mediaStyle
     365    @property mediaStyle
    366366    @abstract The media style for the WebView.
    367367    @discussion The mediaStyle will override the normal value
    … …  
    517517
    518518/*!
    519     @method shouldUpdateWhileOffscreen
     519    @property shouldUpdateWhileOffscreen
    520520    @abstract Whether the WebView is always updated even when it is not in a window that is currently visible.
    521521    @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.

  • trunk/Source/WebKit/mac/WebView/WebViewPrivate.h

    r207512 r207934  
    492492    @param viewClass The WebDocumentView class to use to render data for a given MIME type.
    493493    @param representationClass The WebDocumentRepresentation class to use to represent data of the given MIME type.
    494     @param scheme The URL scheme to represent with an object of the given class.
     494    @param URLScheme The URL scheme to represent with an object of the given class.
    495495*/
    496496+ (void)_registerViewClass:(Class)viewClass representationClass:(Class)representationClass forURLScheme:(NSString *)URLScheme;
    … …  
    575575/*!
    576576    @method setAlwaysShowVerticalScroller:
    577     @result Forces the vertical scroller to be visible if flag is YES, otherwise
     577    @abstract Forces the vertical scroller to be visible if flag is YES, otherwise
    578578    if flag is NO the scroller with automatically show and hide as needed.
    579579 */
    … …  
    588588/*!
    589589    @method setAlwaysShowHorizontalScroller:
    590     @result Forces the horizontal scroller to be visible if flag is YES, otherwise
     590    @abstract Forces the horizontal scroller to be visible if flag is YES, otherwise
    591591    if flag is NO the scroller with automatically show and hide as needed.
    592592 */
    … …  
    795795/*!
    796796    @method setCSSAnimationsSuspended
    797     @param paused YES to suspend animations, NO to resume animations.
     797    @param suspended YES to suspend animations, NO to resume animations.
    798798    @discussion Suspends or resumes all running animations and transitions in the page.
    799799*/
Note: See TracChangeset for help on using the changeset viewer.