[WebKit2][gtk] Fix warnings while generating documentation using gtk-doc.
authorcommit-queue@webkit.org <commit-queue@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 4 Oct 2011 17:39:33 +0000 (17:39 +0000)
committercommit-queue@webkit.org <commit-queue@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 4 Oct 2011 17:39:33 +0000 (17:39 +0000)
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.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@96606 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/WebKit2/ChangeLog
Source/WebKit2/UIProcess/API/gtk/WebKitError.h
Source/WebKit2/UIProcess/API/gtk/WebKitWebLoaderClient.cpp
Source/WebKit2/UIProcess/API/gtk/WebKitWebView.cpp

index eb3df74..833fa8d 100644 (file)
@@ -1,3 +1,18 @@
+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>
 
         Web Inspector: Remove http/tests/inspector/network/disabled-cache-crash.html.
index 5a64f55..656fda7 100644 (file)
@@ -32,6 +32,17 @@ G_BEGIN_DECLS
 
 #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,
     WEBKIT_NETWORK_ERROR_TRANSPORT = 300,
index 978a996..ae5d3b9 100644 (file)
@@ -221,7 +221,7 @@ static void webkit_web_loader_client_class_init(WebKitWebLoaderClientClass* clie
 
     /**
      * WebKitWebLoaderClient::provisional-load-started:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      *
      * This signal is emitted when new load request is made.
      * No data has been received yet, empty structures have
@@ -244,7 +244,7 @@ static void webkit_web_loader_client_class_init(WebKitWebLoaderClientClass* clie
 
     /**
      * WebKitWebLoaderClient::provisional-load-received-server-redirect:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      *
      * This signal is emitted when a provisional data source
      * receives a server redirect.
@@ -266,7 +266,7 @@ static void webkit_web_loader_client_class_init(WebKitWebLoaderClientClass* clie
 
     /**
      * WebKitWebLoaderClient::provisional-load-failed:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      * @error: the #GError that was triggered
      *
      * This signal is emitted when an error occurs when starting to
@@ -293,7 +293,7 @@ static void webkit_web_loader_client_class_init(WebKitWebLoaderClientClass* clie
 
     /**
      * WebKitWebLoaderClient::load-committed:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      *
      * This signal is emitted when content starts arriving for a page load.
      * The necessary transport requirements are stabilished, and the
@@ -315,7 +315,7 @@ static void webkit_web_loader_client_class_init(WebKitWebLoaderClientClass* clie
                      G_TYPE_NONE);
     /**
      * WebKitWebLoaderClient::load-finished:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      *
      * This signal is emitted when a page load completes, that is, when all
      * the resources are done loading with no error. In case of errors
@@ -340,7 +340,7 @@ static void webkit_web_loader_client_class_init(WebKitWebLoaderClientClass* clie
 
     /**
      * WebKitWebLoaderClient::load-failed:
-     * @loader_client: the #WebKitWebLoader
+     * @loader_client: the #WebKitWebLoaderClient
      * @error: the #GError that was triggered
      *
      * This signal is emitted when an error occurs loading a committed data source.
index 893ec4d..05f2dcd 100644 (file)
@@ -157,7 +157,7 @@ GtkWidget* webkit_web_view_new_with_context(WebKitWebContext* context)
  *
  * 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)
 {
@@ -173,7 +173,7 @@ WebKitWebContext* webkit_web_view_get_context(WebKitWebView *webView)
  * Returns the #WebKitWebLoaderClient of @web_view. You can use it
  * 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)
 {