[GTK] Fix remaining introspection warnings
authormrobinson@webkit.org <mrobinson@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Mon, 22 Apr 2013 21:54:02 +0000 (21:54 +0000)
committermrobinson@webkit.org <mrobinson@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Mon, 22 Apr 2013 21:54:02 +0000 (21:54 +0000)
https://bugs.webkit.org/show_bug.cgi?id=114980

Reviewed by Gustavo Noronha Silva.

Source/WebCore:

* bindings/gobject/WebKitDOMCustom.h: Add scope and transfer annotations and flesh
out gtkdoc for completeness.
* bindings/gobject/WebKitDOMEventTarget.h:
(_WebKitDOMEventTargetIface): Ditto and also align virtual method names with those used
for the concrete ones.

Source/WebKit/gtk:

* webkit/webkitspellchecker.h:
(_WebKitSpellCheckerInterface): Align the name of the check_spelling_of_string virtual
method with the concrete method to avoid a g-ir-scanner warning.
* webkit/webkitversion.h.in: Skip WEBKITGTK_API_VERSION for introspection because it
doesn't follow the appropriate namespace name.

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

Source/WebCore/ChangeLog
Source/WebCore/bindings/gobject/WebKitDOMCustom.h
Source/WebCore/bindings/gobject/WebKitDOMEventTarget.h
Source/WebKit/gtk/ChangeLog
Source/WebKit/gtk/webkit/webkitspellchecker.h
Source/WebKit/gtk/webkit/webkitversion.h.in

index d987c06..f7ac5e3 100644 (file)
@@ -1,3 +1,16 @@
+2013-04-22  Martin Robinson  <mrobinson@igalia.com>
+
+        [GTK] Fix remaining introspection warnings
+        https://bugs.webkit.org/show_bug.cgi?id=114980
+
+        Reviewed by Gustavo Noronha Silva.
+
+        * bindings/gobject/WebKitDOMCustom.h: Add scope and transfer annotations and flesh
+        out gtkdoc for completeness.
+        * bindings/gobject/WebKitDOMEventTarget.h:
+        (_WebKitDOMEventTargetIface): Ditto and also align virtual method names with those used
+        for the concrete ones.
+
 2013-04-22  Tim Horton  <timothy_horton@apple.com>
 
         PDFPlugin: Support unlocking encrypted PDFs
index 65bc507..aa2219e 100644 (file)
 
 G_BEGIN_DECLS
 
-WEBKIT_API gboolean webkit_dom_html_text_area_element_is_edited(WebKitDOMHTMLTextAreaElement*);
-WEBKIT_API gboolean webkit_dom_html_input_element_is_edited(WebKitDOMHTMLInputElement*);
+/**
+ * webkit_dom_html_text_area_element_is_edited:
+ * @input: A #WebKitDOMHTMLTextAreaElement
+ *
+ */
+WEBKIT_API gboolean webkit_dom_html_text_area_element_is_edited(WebKitDOMHTMLTextAreaElement* input);
+
+/**
+ * webkit_dom_html_input_element_is_edited:
+ * @input: A #WebKitDOMHTMLInputElement
+ *
+ */
+WEBKIT_API gboolean webkit_dom_html_input_element_is_edited(WebKitDOMHTMLInputElement* input);
 
-/* Compatibility */
+/**
+ * webkit_dom_blob_webkit_slice:
+ * @self: A #WebKitDOMBlob
+ * @start: A #gint64
+ * @end: A #gint64
+ * @content_type: A #gchar
+ *
+ * Returns: (transfer none):
+ */
 WEBKIT_API WebKitDOMBlob* webkit_dom_blob_webkit_slice(WebKitDOMBlob* self, gint64 start, gint64 end, const gchar* content_type);
+
+/**
+ * webkit_dom_html_element_get_class_name:
+ * @element: A #WebKitDOMHTMLElement
+ *
+ * Returns:
+ *
+ */
 WEBKIT_API gchar* webkit_dom_html_element_get_class_name(WebKitDOMHTMLElement* element);
+
+/**
+ * webkit_dom_html_element_set_class_name:
+ * @element: A #WebKitDOMHTMLElement
+ * @value: A #gchar
+ *
+ */
 WEBKIT_API void webkit_dom_html_element_set_class_name(WebKitDOMHTMLElement* element, const gchar* value);
+
+/**
+ * webkit_dom_html_element_get_class_list:
+ * @element: A #WebKitDOMHTMLElement
+ *
+ * Returns: (transfer none):
+ *
+ */
 WEBKIT_API WebKitDOMDOMTokenList* webkit_dom_html_element_get_class_list(WebKitDOMHTMLElement* element);
+
+/**
+ * webkit_dom_html_form_element_dispatch_form_change:
+ * @self: A #WebKitDOMHTMLFormElement
+ *
+ */
 WEBKIT_API void webkit_dom_html_form_element_dispatch_form_change(WebKitDOMHTMLFormElement* self);
+
+/**
+ * webkit_dom_html_form_element_dispatch_form_input:
+ * @self: A #WebKitDOMHTMLFormElement
+ *
+ */
 WEBKIT_API void webkit_dom_html_form_element_dispatch_form_input(WebKitDOMHTMLFormElement* self);
+
+/**
+ * webkit_dom_webkit_named_flow_get_overflow:
+ * @flow: A #WebKitDOMWebKitNamedFlow
+ *
+ * Returns:
+ *
+ */
 WEBKIT_API gboolean webkit_dom_webkit_named_flow_get_overflow(WebKitDOMWebKitNamedFlow* flow);
+
+/**
+ * webkit_dom_element_get_webkit_region_overflow:
+ * @element: A #WebKitDOMElement
+ *
+ * Returns:
+ *
+ */
 WEBKIT_API gchar* webkit_dom_element_get_webkit_region_overflow(WebKitDOMElement* element);
-WEBKIT_API WebKitDOMNodeList* webkit_dom_webkit_named_flow_get_content_nodes(WebKitDOMWebKitNamedFlow* namedFlow);
-WEBKIT_API WebKitDOMNodeList* webkit_dom_webkit_named_flow_get_regions_by_content_node(WebKitDOMWebKitNamedFlow* namedFlow, WebKitDOMNode* contentNode);
+
+/**
+ * webkit_dom_webkit_named_flow_get_content_nodes:
+ * @flow: A #WebKitDOMWebKitNamedFlow
+ *
+ * Returns: (transfer none):
+ *
+ */
+WEBKIT_API WebKitDOMNodeList* webkit_dom_webkit_named_flow_get_content_nodes(WebKitDOMWebKitNamedFlow* flow);
+
+/**
+ * webkit_dom_webkit_named_flow_get_regions_by_content_node:
+ * @flow: A #WebKitDOMWebKitNamedFlow
+ * @content_node: A #WebKitDOMNode
+ *
+ * Returns: (transfer none):
+ *
+ */
+WEBKIT_API WebKitDOMNodeList* webkit_dom_webkit_named_flow_get_regions_by_content_node(WebKitDOMWebKitNamedFlow* flow, WebKitDOMNode* content_node);
 
 G_END_DECLS
 
index 6f2d6fe..102c946 100644 (file)
@@ -41,12 +41,12 @@ struct _WebKitDOMEventTargetIface {
                                      GError              **error);
 
     gboolean      (* add_event_listener)(WebKitDOMEventTarget *target,
-                                         const char          *eventName,
+                                         const char           *event_name,
                                          GCallback             handler,
                                          gboolean              bubble,
-                                         gpointer              userData);
+                                         gpointer              user_data);
     gboolean      (* remove_event_listener)(WebKitDOMEventTarget *target,
-                                            const char           *eventName,
+                                            const char           *event_name,
                                             GCallback             handler,
                                             gboolean              bubble);
 };
@@ -58,14 +58,31 @@ WEBKIT_API void      webkit_dom_event_target_dispatch_event(WebKitDOMEventTarget
                                                             WebKitDOMEvent       *event,
                                                             GError              **error);
 
+/**
+ * webkit_dom_event_target_add_event_listener:
+ * @target: A #WebKitDOMEventTarget
+ * @event_name: A #gchar
+ * @handler: (scope async): A #GCallback
+ * @bubble: A #gboolean
+ * @user_data: A #gpointer
+ *
+ */
 WEBKIT_API gboolean  webkit_dom_event_target_add_event_listener(WebKitDOMEventTarget *target,
-                                                                const char           *eventName,
+                                                                const char           *event_name,
                                                                 GCallback             handler,
                                                                 gboolean              bubble,
-                                                                gpointer              userData);
+                                                                gpointer              user_data);
 
+/**
+ * webkit_dom_event_target_remove_event_listener:
+ * @target: A #WebKitDOMEventTarget
+ * @event_name: A #gchar
+ * @handler: (scope call): A #GCallback
+ * @bubble: A #gboolean
+ *
+ */
 WEBKIT_API gboolean  webkit_dom_event_target_remove_event_listener(WebKitDOMEventTarget *target,
-                                                                   const char           *eventName,
+                                                                   const char           *event_name,
                                                                    GCallback             handler,
                                                                    gboolean              bubble);
 
index 5657e98..4e10e4e 100644 (file)
@@ -1,3 +1,16 @@
+2013-04-22  Martin Robinson  <mrobinson@igalia.com>
+
+        [GTK] Fix remaining introspection warnings
+        https://bugs.webkit.org/show_bug.cgi?id=114980
+
+        Reviewed by Gustavo Noronha Silva.
+
+        * webkit/webkitspellchecker.h:
+        (_WebKitSpellCheckerInterface): Align the name of the check_spelling_of_string virtual
+        method with the concrete method to avoid a g-ir-scanner warning.
+        * webkit/webkitversion.h.in: Skip WEBKITGTK_API_VERSION for introspection because it
+        doesn't follow the appropriate namespace name.
+
 2013-04-22  Zan Dobersek  <zdobersek@igalia.com>
 
         [GTK] Set up libPlatform.la
index b70e2d0..3df9561 100644 (file)
@@ -33,7 +33,7 @@ G_BEGIN_DECLS
 struct _WebKitSpellCheckerInterface {
     GTypeInterface g_iface;
 
-    void   (*check_spelling_of_string)                        (WebKitSpellChecker* checker, const char* word, int* misspelling_location, int* misspelling_length);
+    void   (*check_spelling_of_string)                        (WebKitSpellChecker* checker, const char* string, int* misspelling_location, int* misspelling_length);
     char** (*get_guesses_for_word)                            (WebKitSpellChecker* checker, const char* word, const char* context);
     void   (*update_spell_checking_languages)                 (WebKitSpellChecker* checker, const char* languages);
     char*  (*get_autocorrect_suggestions_for_misspelled_word) (WebKitSpellChecker* checker, const char* word);
index ce6b569..4d63655 100644 (file)
@@ -30,6 +30,10 @@ G_BEGIN_DECLS
 #define WEBKIT_MICRO_VERSION (@WEBKIT_MICRO_VERSION@)
 #define WEBKIT_USER_AGENT_MAJOR_VERSION (@WEBKIT_USER_AGENT_MAJOR_VERSION@)
 #define WEBKIT_USER_AGENT_MINOR_VERSION (@WEBKIT_USER_AGENT_MINOR_VERSION@)
+
+/**
+ * WEBKITGTK_API_VERSION: (skip)
+ */
 #define WEBKITGTK_API_VERSION (@WEBKITGTK_API_VERSION@)
 
 #define WEBKIT_CHECK_VERSION(major, minor, micro) \