[GTK] Fix some simple gtkdoc warnings for WebKit1
authormrobinson@webkit.org <mrobinson@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 4 Mar 2014 07:36:02 +0000 (07:36 +0000)
committermrobinson@webkit.org <mrobinson@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 4 Mar 2014 07:36:02 +0000 (07:36 +0000)
https://bugs.webkit.org/show_bug.cgi?id=129659

Reviewed by Carlos Garcia Campos.

* docs/webkitgtk-sections.txt: Make public some enum documentation that is used
in public APIs.
* webkit/webkitwebview.cpp: Fix typos and add documentation for enums previously
marked as private.
(webkit_web_view_class_init):
* webkit/webkitwebview.h: Ditto.

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

Source/WebKit/gtk/ChangeLog
Source/WebKit/gtk/docs/webkitgtk-sections.txt
Source/WebKit/gtk/webkit/webkitwebview.cpp
Source/WebKit/gtk/webkit/webkitwebview.h

index 71b3ce2..42e4adf 100644 (file)
@@ -1,3 +1,17 @@
+2014-03-03  Martin Robinson  <mrobinson@igalia.com>
+
+        [GTK] Fix some simple gtkdoc warnings for WebKit1
+        https://bugs.webkit.org/show_bug.cgi?id=129659
+
+        Reviewed by Carlos Garcia Campos.
+
+        * docs/webkitgtk-sections.txt: Make public some enum documentation that is used
+        in public APIs.
+        * webkit/webkitwebview.cpp: Fix typos and add documentation for enums previously
+        marked as private.
+        (webkit_web_view_class_init):
+        * webkit/webkitwebview.h: Ditto.
+
 2014-02-26  Joseph Pecoraro  <pecoraro@apple.com>
 
         Web Inspector: Remove console.profiles from window.console API
index b707bf8..d26ef75 100644 (file)
@@ -401,6 +401,8 @@ webkit_network_response_get_type
 WebKitNavigationResponse
 WebKitWebViewTargetInfo
 WebKitWebViewViewMode
+WebKitInsertAction
+WebKitSelectionAffinity
 <TITLE>WebKitWebView</TITLE>
 WebKitWebView
 webkit_web_view_can_copy_clipboard
@@ -488,8 +490,6 @@ WEBKIT_WEB_VIEW_GET_CLASS
 webkit_web_view_get_type
 WebKitWebViewPrivate
 WebKitWebViewClass
-WebKitInsertAction
-WebKitSelectionAffinity
 </SECTION>
 
 <SECTION>
index bb082be..8035a3b 100644 (file)
@@ -2767,7 +2767,7 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
     /**
      * WebKitWebView::should-show-delete-interface-for-element:
      * @web_view: the #WebKitWebView on which the signal is emitted
-     * @element: a #WebKitDOMHtmlElement
+     * @element: a #WebKitDOMHTMLElement
      *
      */
     webkit_web_view_signals[SHOULD_SHOW_DELETE_INTERFACE_FOR_ELEMENT] = g_signal_new("should-show-delete-interface-for-element",
@@ -2784,7 +2784,7 @@ static void webkit_web_view_class_init(WebKitWebViewClass* webViewClass)
      * @web_view: the #WebKitWebView on which the signal is emitted
      * @fromRange: a #WebKitDOMRange
      * @toRange: a #WebKitDOMRange
-     * @affinity: a #WebKitElectionAffinity
+     * @affinity: a #WebKitSelectionAffinity
      * @stillSelecting: bool
      *
      */
index 12ea0d6..cd3edf0 100644 (file)
@@ -98,12 +98,27 @@ typedef enum
     WEBKIT_WEB_VIEW_VIEW_MODE_MINIMIZED
 } WebKitWebViewViewMode;
 
+/**
+ * WebKitSelectionAffinity:
+ * @WEBKIT_SELECTION_AFFINITY_UPSTREAM: Downstream selection affinity
+ * @WEBKIT_SELECTION_AFFINITY_DOWNSTREAM: Upstream selection affinity
+ *
+ * Enum values used to denote selection affinity.
+ **/
 typedef enum
 {
     WEBKIT_SELECTION_AFFINITY_UPSTREAM,
     WEBKIT_SELECTION_AFFINITY_DOWNSTREAM,
 } WebKitSelectionAffinity;
 
+/**
+ * WebKitInsertAction:
+ * @WEBKIT_INSERT_ACTION_TYPED: The insert action was from typing.
+ * @WEBKIT_INSERT_ACTION_PASTED: The insert action was from pasting.
+ * @WEBKIT_INSERT_ACTION_DROPPED: The insert action was from dragging and dropping.
+ *
+ * Enum values used to denote source of an insert action.
+ **/
 typedef enum
 {
     WEBKIT_INSERT_ACTION_TYPED,