Title: [155952] trunk/Source/WebCore
Revision
155952
Author
carlo...@webkit.org
Date
2013-09-17 06:38:10 -0700 (Tue, 17 Sep 2013)

Log Message

[GTK] Do not include Returns tag in api doc for methods returning void
https://bugs.webkit.org/show_bug.cgi?id=121488

Reviewed by Philippe Normand.

* bindings/gobject/WebKitDOMCustom.h:
* bindings/scripts/CodeGeneratorGObject.pm:
(GenerateFunction): Only add Returns tag for methods not returning
void.
* bindings/scripts/test/GObject/WebKitDOMTestActiveDOMObject.h:
* bindings/scripts/test/GObject/WebKitDOMTestCustomNamedGetter.h:
* bindings/scripts/test/GObject/WebKitDOMTestInterface.h:
* bindings/scripts/test/GObject/WebKitDOMTestObj.h:
* bindings/scripts/test/GObject/WebKitDOMTestTypedefs.h:

Modified Paths

Diff

Modified: trunk/Source/WebCore/ChangeLog (155951 => 155952)


--- trunk/Source/WebCore/ChangeLog	2013-09-17 13:24:28 UTC (rev 155951)
+++ trunk/Source/WebCore/ChangeLog	2013-09-17 13:38:10 UTC (rev 155952)
@@ -1,3 +1,20 @@
+2013-09-17  Carlos Garcia Campos  <cgar...@igalia.com>
+
+        [GTK] Do not include Returns tag in api doc for methods returning void
+        https://bugs.webkit.org/show_bug.cgi?id=121488
+
+        Reviewed by Philippe Normand.
+
+        * bindings/gobject/WebKitDOMCustom.h:
+        * bindings/scripts/CodeGeneratorGObject.pm:
+        (GenerateFunction): Only add Returns tag for methods not returning
+        void.
+        * bindings/scripts/test/GObject/WebKitDOMTestActiveDOMObject.h:
+        * bindings/scripts/test/GObject/WebKitDOMTestCustomNamedGetter.h:
+        * bindings/scripts/test/GObject/WebKitDOMTestInterface.h:
+        * bindings/scripts/test/GObject/WebKitDOMTestObj.h:
+        * bindings/scripts/test/GObject/WebKitDOMTestTypedefs.h:
+
 2013-09-17  Michael BrĂ¼ning  <michael.brun...@digia.com>
 
         Correct range used for Emoji checks.

Modified: trunk/Source/WebCore/bindings/gobject/WebKitDOMCustom.h (155951 => 155952)


--- trunk/Source/WebCore/bindings/gobject/WebKitDOMCustom.h	2013-09-17 13:24:28 UTC (rev 155951)
+++ trunk/Source/WebCore/bindings/gobject/WebKitDOMCustom.h	2013-09-17 13:38:10 UTC (rev 155952)
@@ -29,6 +29,7 @@
  * webkit_dom_html_text_area_element_is_edited:
  * @input: A #WebKitDOMHTMLTextAreaElement
  *
+ * Returns:
  */
 WEBKIT_API gboolean webkit_dom_html_text_area_element_is_edited(WebKitDOMHTMLTextAreaElement* input);
 
@@ -36,6 +37,7 @@
  * webkit_dom_html_input_element_is_edited:
  * @input: A #WebKitDOMHTMLInputElement
  *
+ * Returns:
  */
 WEBKIT_API gboolean webkit_dom_html_input_element_is_edited(WebKitDOMHTMLInputElement* input);
 
@@ -212,8 +214,6 @@
  * webkit_dom_html_document_open:
  * @self: A #WebKitDOMHTMLDocument
  *
- * Returns:
- *
 **/
 WEBKIT_API void webkit_dom_html_document_open(WebKitDOMHTMLDocument* self);
 
@@ -224,8 +224,6 @@
  *
  * This functionality has been removed from WebKit, this function does nothing.
  *
- * Returns:
- *
 **/
 WEBKIT_API void webkit_dom_html_element_set_item_id(WebKitDOMHTMLElement* self, const gchar* value);
 
@@ -269,8 +267,6 @@
  *
  * This functionality has been removed from WebKit, this function does nothing.
  *
- * Returns:
- *
 **/
 WEBKIT_API void webkit_dom_html_element_set_item_scope(WebKitDOMHTMLElement* self, gboolean value);
 

Modified: trunk/Source/WebCore/bindings/scripts/CodeGeneratorGObject.pm (155951 => 155952)


--- trunk/Source/WebCore/bindings/scripts/CodeGeneratorGObject.pm	2013-09-17 13:24:28 UTC (rev 155951)
+++ trunk/Source/WebCore/bindings/scripts/CodeGeneratorGObject.pm	2013-09-17 13:38:10 UTC (rev 155952)
@@ -954,7 +954,7 @@
     push(@hBody, " *\n");
     if (IsGDOMClassType($function->signature->type)) {
         push(@hBody, " * Returns: (transfer none):\n");
-    } else {
+    } elsif ($returnType ne "void") {
         push(@hBody, " * Returns:\n");
     }
     push(@hBody, " *\n");

Modified: trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestActiveDOMObject.h (155951 => 155952)


--- trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestActiveDOMObject.h	2013-09-17 13:24:28 UTC (rev 155951)
+++ trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestActiveDOMObject.h	2013-09-17 13:38:10 UTC (rev 155952)
@@ -54,7 +54,6 @@
  * @self: A #WebKitDOMTestActiveDOMObject
  * @nextChild: A #WebKitDOMNode
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -65,7 +64,6 @@
  * @self: A #WebKitDOMTestActiveDOMObject
  * @message: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void

Modified: trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestCustomNamedGetter.h (155951 => 155952)


--- trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestCustomNamedGetter.h	2013-09-17 13:24:28 UTC (rev 155951)
+++ trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestCustomNamedGetter.h	2013-09-17 13:38:10 UTC (rev 155952)
@@ -54,7 +54,6 @@
  * @self: A #WebKitDOMTestCustomNamedGetter
  * @str: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void

Modified: trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestInterface.h (155951 => 155952)


--- trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestInterface.h	2013-09-17 13:24:28 UTC (rev 155951)
+++ trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestInterface.h	2013-09-17 13:38:10 UTC (rev 155952)
@@ -53,7 +53,6 @@
  * webkit_dom_test_interface_implements_method1:
  * @self: A #WebKitDOMTestInterface
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -76,7 +75,6 @@
  * webkit_dom_test_interface_implements_method4:
  * @self: A #WebKitDOMTestInterface
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -86,7 +84,6 @@
  * webkit_dom_test_interface_supplemental_method1:
  * @self: A #WebKitDOMTestInterface
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -109,7 +106,6 @@
  * webkit_dom_test_interface_supplemental_method4:
  * @self: A #WebKitDOMTestInterface
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -140,7 +136,6 @@
  * @self: A #WebKitDOMTestInterface
  * @value: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -192,7 +187,6 @@
  * @self: A #WebKitDOMTestInterface
  * @value: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void

Modified: trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestObj.h (155951 => 155952)


--- trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestObj.h	2013-09-17 13:24:28 UTC (rev 155951)
+++ trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestObj.h	2013-09-17 13:38:10 UTC (rev 155952)
@@ -53,7 +53,6 @@
  * webkit_dom_test_obj_void_method:
  * @self: A #WebKitDOMTestObj
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -66,7 +65,6 @@
  * @strArg: A #gchar
  * @objArg: A #WebKitDOMTestObj
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -169,7 +167,6 @@
  * @self: A #WebKitDOMTestObj
  * @enumArg: A #WebKitDOMTestEnumType
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -193,7 +190,6 @@
  * @self: A #WebKitDOMTestObj
  * @serializedArg: A #WebKitDOMSerializedScriptValue
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -205,7 +201,6 @@
  * @oo: A #WebKitDOMDictionary
  * @ooo: A #WebKitDOMDictionary
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -216,7 +211,6 @@
  * @self: A #WebKitDOMTestObj
  * @error: #GError
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -226,7 +220,6 @@
  * webkit_dom_test_obj_with_script_state_void:
  * @self: A #WebKitDOMTestObj
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -247,7 +240,6 @@
  * @self: A #WebKitDOMTestObj
  * @error: #GError
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -268,7 +260,6 @@
  * webkit_dom_test_obj_with_script_execution_context:
  * @self: A #WebKitDOMTestObj
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -278,7 +269,6 @@
  * webkit_dom_test_obj_with_script_execution_context_and_script_state:
  * @self: A #WebKitDOMTestObj
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -310,7 +300,6 @@
  * @self: A #WebKitDOMTestObj
  * @opt: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -322,7 +311,6 @@
  * @nonOpt: A #glong
  * @opt: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -335,7 +323,6 @@
  * @opt1: A #glong
  * @opt2: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -346,7 +333,6 @@
  * @self: A #WebKitDOMTestObj
  * @str: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -357,7 +343,6 @@
  * @self: A #WebKitDOMTestObj
  * @str: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -368,7 +353,6 @@
  * @self: A #WebKitDOMTestObj
  * @str: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -388,7 +372,6 @@
  * webkit_dom_test_obj_conditional_method2:
  * @self: A #WebKitDOMTestObj
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -398,7 +381,6 @@
  * webkit_dom_test_obj_conditional_method3:
  * @self: A #WebKitDOMTestObj
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -408,7 +390,6 @@
  * webkit_dom_test_obj_class_method:
  * @self: A #WebKitDOMTestObj
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -430,7 +411,6 @@
  * @self: A #WebKitDOMTestObj
  * @arg: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -441,7 +421,6 @@
  * @self: A #WebKitDOMTestObj
  * @type: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -452,7 +431,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #WebKitDOMTestNode
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -463,7 +441,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #WebKitDOMTestNode
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -474,7 +451,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #WebKitDOMTestNode
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -485,7 +461,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #WebKitDOMTestNode
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -515,7 +490,6 @@
  * webkit_dom_test_obj_orange:
  * @self: A #WebKitDOMTestObj
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -541,7 +515,6 @@
  * @head: A #gchar
  * @tail: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -553,7 +526,6 @@
  * @head: A #gdouble
  * @tail: A #gdouble
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -565,7 +537,6 @@
  * @head: A #WebKitDOMNode
  * @tail: A #WebKitDOMNode
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -616,7 +587,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gint8
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -637,7 +607,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #guint8
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -658,7 +627,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gshort
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -679,7 +647,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gushort
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -700,7 +667,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -721,7 +687,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gint64
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -742,7 +707,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #guint64
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -763,7 +727,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -826,7 +789,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gboolean
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -847,7 +809,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -868,7 +829,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -889,7 +849,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gulong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -910,7 +869,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gboolean
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -931,7 +889,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -952,7 +909,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -973,7 +929,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -994,7 +949,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gboolean
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1015,7 +969,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1037,7 +990,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1059,7 +1011,6 @@
  * @value: A #glong
  * @error: #GError
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1081,7 +1032,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1103,7 +1053,6 @@
  * @value: A #gchar
  * @error: #GError
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1124,7 +1073,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1274,7 +1222,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1295,7 +1242,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1316,7 +1262,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1410,7 +1355,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1431,7 +1375,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #gfloat
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1462,7 +1405,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1543,7 +1485,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -1565,7 +1506,6 @@
  * @self: A #WebKitDOMTestObj
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void

Modified: trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestTypedefs.h (155951 => 155952)


--- trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestTypedefs.h	2013-09-17 13:24:28 UTC (rev 155951)
+++ trunk/Source/WebCore/bindings/scripts/test/GObject/WebKitDOMTestTypedefs.h	2013-09-17 13:38:10 UTC (rev 155952)
@@ -54,7 +54,6 @@
  * @self: A #WebKitDOMTestTypedefs
  * @x: A #WebKitDOMlong[]
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -69,7 +68,6 @@
  * @color: A #gchar
  * @alpha: A #gfloat
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -80,7 +78,6 @@
  * @self: A #WebKitDOMTestTypedefs
  * @arrayArg: A #WebKitDOMDOMString[]
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -125,7 +122,6 @@
  * @self: A #WebKitDOMTestTypedefs
  * @error: #GError
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -146,7 +142,6 @@
  * @self: A #WebKitDOMTestTypedefs
  * @value: A #guint64
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -189,7 +184,6 @@
  * @self: A #WebKitDOMTestTypedefs
  * @value: A #glong
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -211,7 +205,6 @@
  * @value: A #glong
  * @error: #GError
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -233,7 +226,6 @@
  * @self: A #WebKitDOMTestTypedefs
  * @value: A #gchar
  *
- * Returns:
  *
 **/
 WEBKIT_API void
@@ -255,7 +247,6 @@
  * @value: A #gchar
  * @error: #GError
  *
- * Returns:
  *
 **/
 WEBKIT_API void
_______________________________________________
webkit-changes mailing list
webkit-changes@lists.webkit.org
https://lists.webkit.org/mailman/listinfo/webkit-changes

Reply via email to