Title: [233544] trunk/Source/WebKit
- Revision
- 233544
- Author
- [email protected]
- Date
- 2018-07-05 15:20:08 -0700 (Thu, 05 Jul 2018)
Log Message
Fix some -Wdocumentation warnings in WebKit
https://bugs.webkit.org/show_bug.cgi?id=187318
Reviewed by Dan Bernstein.
Fix most of the -Wdocumentation warnings in WebKit. The remaining
ones are slightly mysterious, so we can't turn the warning on yet.
* Configurations/BaseTarget.xcconfig:
Define U_HIDE_DEPRECATED_API. It's defined in all other WebKit projects,
and the doc comments in the deprecated ICU API have some errors.
* UIProcess/API/Cocoa/WKUIDelegate.h:
* UIProcess/API/Cocoa/WKWebView.h:
* UIProcess/API/Cocoa/WKWebsiteDataStore.h:
Adjust comments or parameter names to be consistent with each other.
Modified Paths
Diff
Modified: trunk/Source/WebKit/ChangeLog (233543 => 233544)
--- trunk/Source/WebKit/ChangeLog 2018-07-05 21:51:25 UTC (rev 233543)
+++ trunk/Source/WebKit/ChangeLog 2018-07-05 22:20:08 UTC (rev 233544)
@@ -1,3 +1,22 @@
+2018-07-05 Tim Horton <[email protected]>
+
+ Fix some -Wdocumentation warnings in WebKit
+ https://bugs.webkit.org/show_bug.cgi?id=187318
+
+ Reviewed by Dan Bernstein.
+
+ Fix most of the -Wdocumentation warnings in WebKit. The remaining
+ ones are slightly mysterious, so we can't turn the warning on yet.
+
+ * Configurations/BaseTarget.xcconfig:
+ Define U_HIDE_DEPRECATED_API. It's defined in all other WebKit projects,
+ and the doc comments in the deprecated ICU API have some errors.
+
+ * UIProcess/API/Cocoa/WKUIDelegate.h:
+ * UIProcess/API/Cocoa/WKWebView.h:
+ * UIProcess/API/Cocoa/WKWebsiteDataStore.h:
+ Adjust comments or parameter names to be consistent with each other.
+
2018-07-05 Chris Dumez <[email protected]>
Regression(r232886): WebsiteDataStore objects may get destroyed on a background thread
Modified: trunk/Source/WebKit/Configurations/BaseTarget.xcconfig (233543 => 233544)
--- trunk/Source/WebKit/Configurations/BaseTarget.xcconfig 2018-07-05 21:51:25 UTC (rev 233543)
+++ trunk/Source/WebKit/Configurations/BaseTarget.xcconfig 2018-07-05 22:20:08 UTC (rev 233544)
@@ -34,7 +34,7 @@
SYSTEM_FRAMEWORK_SEARCH_PATHS = $(inherited) $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/PrivateFrameworks $(SDKROOT)$(SYSTEM_LIBRARY_DIR)/Frameworks;
GCC_PREFIX_HEADER = WebKit2Prefix.h;
-GCC_PREPROCESSOR_DEFINITIONS = $(DEBUG_DEFINES) $(FEATURE_DEFINES) $(WK_MANUAL_SANDBOXING_DEFINES) $(WK_CORE_PREDICTION_DEFINES) U_DISABLE_RENAMING=1 U_SHOW_CPLUSPLUS_API=0 FRAMEWORK_NAME=WebKit;
+GCC_PREPROCESSOR_DEFINITIONS = $(DEBUG_DEFINES) $(FEATURE_DEFINES) $(WK_MANUAL_SANDBOXING_DEFINES) $(WK_CORE_PREDICTION_DEFINES) U_HIDE_DEPRECATED_API U_DISABLE_RENAMING=1 U_SHOW_CPLUSPLUS_API=0 FRAMEWORK_NAME=WebKit;
WEBKITADDITIONS_HEADER_SEARCH_PATHS = $(BUILT_PRODUCTS_DIR)/usr/local/include/WebKitAdditions $(SDKROOT)/usr/local/include/WebKitAdditions;
LIBWEBRTC_HEADER_SEARCH_PATHS = $(BUILT_PRODUCTS_DIR)/usr/local/include/webrtc $(SDKROOT)/usr/local/include/webrtc;
Modified: trunk/Source/WebKit/UIProcess/API/Cocoa/WKUIDelegate.h (233543 => 233544)
--- trunk/Source/WebKit/UIProcess/API/Cocoa/WKUIDelegate.h 2018-07-05 21:51:25 UTC (rev 233543)
+++ trunk/Source/WebKit/UIProcess/API/Cocoa/WKUIDelegate.h 2018-07-05 22:20:08 UTC (rev 233544)
@@ -102,7 +102,7 @@
/*! @abstract Displays a _javascript_ text input panel.
@param webView The web view invoking the delegate method.
- @param message The message to display.
+ @param prompt The prompt to display.
@param defaultText The initial text to display in the text entry field.
@param frame Information about the frame whose _javascript_ initiated this call.
@param completionHandler The completion handler to call after the text
Modified: trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebView.h (233543 => 233544)
--- trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebView.h 2018-07-05 21:51:25 UTC (rev 233543)
+++ trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebView.h 2018-07-05 22:20:08 UTC (rev 233544)
@@ -111,7 +111,7 @@
/*! @abstract Sets the webpage contents and base URL.
@param data The data to use as the contents of the webpage.
@param MIMEType The MIME type of the data.
- @param encodingName The data's character encoding name.
+ @param characterEncodingName The data's character encoding name.
@param baseURL A URL that is used to resolve relative URLs within the document.
@result A new navigation.
*/
Modified: trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebsiteDataStore.h (233543 => 233544)
--- trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebsiteDataStore.h 2018-07-05 21:51:25 UTC (rev 233543)
+++ trunk/Source/WebKit/UIProcess/API/Cocoa/WKWebsiteDataStore.h 2018-07-05 22:20:08 UTC (rev 233544)
@@ -75,7 +75,7 @@
@param date A date. All website data modified after this date will be removed.
@param completionHandler A block to invoke when the website data has been removed.
*/
-- (void)removeDataOfTypes:(NSSet<NSString *> *)websiteDataTypes modifiedSince:(NSDate *)date completionHandler:(void (^)(void))completionHandler;
+- (void)removeDataOfTypes:(NSSet<NSString *> *)dataTypes modifiedSince:(NSDate *)date completionHandler:(void (^)(void))completionHandler;
/*! @abstract Returns the cookie store representing HTTP cookies in this website data store. */
@property (nonatomic, readonly) WKHTTPCookieStore *httpCookieStore WK_API_AVAILABLE(macosx(10.13), ios(11.0));
_______________________________________________
webkit-changes mailing list
[email protected]
https://lists.webkit.org/mailman/listinfo/webkit-changes
