Changeset 96606 in webkit

Timestamp:

Oct 4, 2011 10:39:33 AM (13 years ago)

Author:

commit-queue@webkit.org

Message:

[WebKit2][gtk] Fix warnings while generating documentation using gtk-doc.
​https://bugs.webkit.org/show_bug.cgi?id=69329

Patch by Nayan Kumar K <​nayankk@motorola.com> on 2011-10-04
Reviewed by Martin Robinson.

Added documentation for WebKitNetworkError enum and corrected few other
minor issues in WebKit2-GTK+ API documentation.

• UIProcess/API/gtk/WebKitError.h: Added documentation for WebKitNetworkError.
• UIProcess/API/gtk/WebKitWebLoaderClient.cpp:

(webkit_web_loader_client_class_init): Corrected parameter name.

• UIProcess/API/gtk/WebKitWebView.cpp: Corrected annotation.

Location:

trunk/Source/WebKit2

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/API/gtk/WebKitError.h (modified) (1 diff)
• UIProcess/API/gtk/WebKitWebLoaderClient.cpp (modified) (6 diffs)
• UIProcess/API/gtk/WebKitWebView.cpp (modified) (2 diffs)

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2011-10-04  Nayan Kumar K  <nayankk@motorola.com>
+
+        [WebKit2][gtk] Fix warnings while generating documentation using gtk-doc.
+        https://bugs.webkit.org/show_bug.cgi?id=69329
+
+        Reviewed by Martin Robinson.
+
+        Added documentation for WebKitNetworkError enum and corrected few other
+        minor issues in WebKit2-GTK+ API documentation.
+
+        * UIProcess/API/gtk/WebKitError.h: Added documentation for WebKitNetworkError.
+        * UIProcess/API/gtk/WebKitWebLoaderClient.cpp:
+        (webkit_web_loader_client_class_init): Corrected parameter name.
+        * UIProcess/API/gtk/WebKitWebView.cpp: Corrected annotation.
+
 2011-10-04  Vsevolod Vlasov  <vsevik@chromium.org>
 

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitError.h

@@ -33 +33 @@
 #define WEBKIT_NETWORK_ERROR webkit_network_error_quark ()
 
+/**
+ * WebKitNetworkError:
+ * @WEBKIT_NETWORK_ERROR_FAILED: Generic load failure
+ * @WEBKIT_NETWORK_ERROR_TRANSPORT: Load failure due to transport error
+ * @WEBKIT_NETWORK_ERROR_UNKNOWN_PROTOCOL: Load failure due to unknown protocol
+ * @WEBKIT_NETWORK_ERROR_CANCELLED: Load failure due to cancellation
+ * @WEBKIT_NETWORK_ERROR_FILE_DOES_NOT_EXIST: Load failure due to missing file
+ *
+ * Enum values used to denote the various network errors.
+ *
+ **/
 typedef enum {
     WEBKIT_NETWORK_ERROR_FAILED = 399,

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitWebLoaderClient.cpp

@@ -222 +222 @@
     /**
      * WebKitWebLoaderClient::provisional-load-started:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      *
      * This signal is emitted when new load request is made.
@@ -245 +245 @@
     /**
      * WebKitWebLoaderClient::provisional-load-received-server-redirect:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      *
      * This signal is emitted when a provisional data source
@@ -267 +267 @@
     /**
      * WebKitWebLoaderClient::provisional-load-failed:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      * @error: the #GError that was triggered
      *
@@ -294 +294 @@
     /**
      * WebKitWebLoaderClient::load-committed:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      *
      * This signal is emitted when content starts arriving for a page load.
@@ -316 +316 @@
     /**
      * WebKitWebLoaderClient::load-finished:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      *
      * This signal is emitted when a page load completes, that is, when all
@@ -341 +341 @@
     /**
      * WebKitWebLoaderClient::load-failed:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      * @error: the #GError that was triggered
      *

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitWebView.cpp

@@ -158 +158 @@
  * Gets the web context of @web_view.
  *
- * Returns: (transfer-none): the #WebKitWebContext of the view
+ * Returns: (transfer none): the #WebKitWebContext of the view
  */
 WebKitWebContext* webkit_web_view_get_context(WebKitWebView *webView)
@@ -174 +174 @@
  * to monitor the status of load operations happening on @web_view.
  *
- * Returns: (trasnfer-none): the #WebKitWebLoaderClient of @web_view.
+ * Returns: (transfer none): the #WebKitWebLoaderClient of @web_view.
  */
 WebKitWebLoaderClient* webkit_web_view_get_loader_client(WebKitWebView* webView)