Changeset 106788 in webkit

Timestamp:

Feb 6, 2012 1:29:34 AM (12 years ago)

Author:

Carlos Garcia Campos

Message:

[GTK] Fix several gtkdoc-fixxref warnings
​https://bugs.webkit.org/show_bug.cgi?id=77613

Reviewed by Martin Robinson.

Source/WebKit/gtk:

• docs/webkitgtk-docs.sgml: Remove webkitspellcheckerenchant

section.

• docs/webkitgtk-sections.txt: Remove webkitspellcheckerenchant

symbols and move WebKitWebNavigationReason from the private
section to the global section.

• webkit/webkitwebnavigationaction.h: Document

WebKitWebNavigationReason enum.

Source/WebKit2:

• UIProcess/API/gtk/WebKitWindowProperties.cpp: Fix a typo, a

colon was missing in WebKitWebView::ready-to-show.

Tools:

• gtk/generate-gtkdoc:

(get_webkit1_options): Add webkitspellcheckerenchant.* to the list
of ignored files, since it's private.

• gtk/gtkdoc.py:

(GTKDoc._ignored_files_basenames): Helper function that returns a
string with the list of ignored files basenames separated by a
spaces, as expected by several gtkdoc commands.
(GTKDoc._run_gtkdoc_scan): Use _ignored_files_basenames for
--ignore-headers option.
(GTKDoc._run_gtkdoc_mkdb): Use _ignored_files_basenames for
--ignore-files option.

Location:

trunk

Files:

• Source/WebKit/gtk/ChangeLog (modified) (1 diff)
• Source/WebKit/gtk/docs/webkitgtk-docs.sgml (modified) (1 diff)
• Source/WebKit/gtk/docs/webkitgtk-sections.txt (modified) (3 diffs)
• Source/WebKit/gtk/webkit/webkitwebnavigationaction.h (modified) (1 diff)
• Source/WebKit2/ChangeLog (modified) (1 diff)
• Source/WebKit2/UIProcess/API/gtk/WebKitWindowProperties.cpp (modified) (1 diff)
• Tools/ChangeLog (modified) (1 diff)
• Tools/gtk/generate-gtkdoc (modified) (1 diff)
• Tools/gtk/gtkdoc.py (modified) (3 diffs)

trunk/Source/WebKit/gtk/ChangeLog

@@ +1 @@
+2012-02-06  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK] Fix several gtkdoc-fixxref warnings
+        https://bugs.webkit.org/show_bug.cgi?id=77613
+
+        Reviewed by Martin Robinson.
+
+        * docs/webkitgtk-docs.sgml: Remove webkitspellcheckerenchant
+        section.
+        * docs/webkitgtk-sections.txt: Remove webkitspellcheckerenchant
+        symbols and move WebKitWebNavigationReason from the private
+        section to the global section.
+        * webkit/webkitwebnavigationaction.h: Document
+        WebKitWebNavigationReason enum.
+
 2012-02-02  Kalev Lember  <kalevlember@gmail.com>
 

trunk/Source/WebKit/gtk/docs/webkitgtk-docs.sgml

@@ -41 +41 @@
     <xi:include href="xml/webkiticondatabase.xml"/>
     <xi:include href="xml/webkitspellchecker.xml"/>
-    <xi:include href="xml/webkitspellcheckerenchant.xml"/>
   </chapter>
 

trunk/Source/WebKit/gtk/docs/webkitgtk-sections.txt

@@ -293 +293 @@
 <TITLE>WebKitWebNavigationAction</TITLE>
 WebKitWebNavigationAction
+WebKitWebNavigationReason
 webkit_web_navigation_action_get_button
 webkit_web_navigation_action_get_modifier_state
@@ -308 +309 @@
 WEBKIT_WEB_NAVIGATION_ACTION_GET_CLASS
 <SUBSECTION Private>
-WebKitWebNavigationReason
 WebKitWebNavigationActionClass
 WebKitWebNavigationActionPrivate
@@ -640 +640 @@
 
 <SECTION>
-<FILE>webkitspellcheckerenchant</FILE>
-<TITLE>WebKitSpellCheckerEnchant</TITLE>
-<SUBSECTION Standard>
-WEBKIT_IS_SPELL_CHECKER_ENCHANT
-WEBKIT_IS_SPELL_CHECKER_ENCHANT_CLASS
-WEBKIT_SPELL_CHECKER_ENCHANT
-WEBKIT_SPELL_CHECKER_ENCHANT_CLASS
-WEBKIT_SPELL_CHECKER_ENCHANT_GET_CLASS
-WEBKIT_TYPE_SPELL_CHECKER_ENCHANT
-<SUBSECTION Private>
-WebKitSpellCheckerEnchant
-WebKitSpellCheckerEnchantClass
-WebKitSpellCheckerEnchantPrivate
-webkit_spell_checker_enchant_get_type
-</SECTION>
-
-<SECTION>
 <FILE>webkiterror</FILE>
 WEBKIT_NETWORK_ERROR

trunk/Source/WebKit/gtk/webkit/webkitwebnavigationaction.h

@@ -27 +27 @@
 G_BEGIN_DECLS
 
-/*
- * The order of this enum must be the same as NavigationType in
- * FrameLoaderTypes.h
+/**
+ * WebKitWebNavigationReason:
+ * @WEBKIT_WEB_NAVIGATION_REASON_LINK_CLICKED: The navigation was triggered by clicking a link.
+ * @WEBKIT_WEB_NAVIGATION_REASON_FORM_SUBMITTED: The navigation was triggered by submitting a form.
+ * @WEBKIT_WEB_NAVIGATION_REASON_BACK_FORWARD: The navigation was triggered by navigating forward or backward.
+ * @WEBKIT_WEB_NAVIGATION_REASON_RELOAD: The navigation was triggered by reloading.
+ * @WEBKIT_WEB_NAVIGATION_REASON_FORM_RESUBMITTED: The navigation was triggered by resubmitting a form.
+ * @WEBKIT_WEB_NAVIGATION_REASON_OTHER: The navigation was triggered by some other action.
+ *
+ * Enum values used to denote the various navigation reasons.
  */
 typedef enum {

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2012-02-06  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK] Fix several gtkdoc-fixxref warnings
+        https://bugs.webkit.org/show_bug.cgi?id=77613
+
+        Reviewed by Martin Robinson.
+
+        * UIProcess/API/gtk/WebKitWindowProperties.cpp: Fix a typo, a
+        colon was missing in WebKitWebView::ready-to-show.
+
 2012-02-05  Dan Bernstein  <mitz@apple.com>
 

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

@@ -39 +39 @@
  * and the request to show the #WebKitWebView fullscreen.
  *
- * The #WebKitWebView:ready-to-show signal handler is the proper place
+ * The #WebKitWebView::ready-to-show signal handler is the proper place
  * to apply the initial window properties. Then you can monitor the
  * #WebKitWindowProperties by connecting to ::notify signal.

trunk/Tools/ChangeLog

@@ +1 @@
+2012-02-06  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK] Fix several gtkdoc-fixxref warnings
+        https://bugs.webkit.org/show_bug.cgi?id=77613
+
+        Reviewed by Martin Robinson.
+
+        * gtk/generate-gtkdoc:
+        (get_webkit1_options): Add webkitspellcheckerenchant.* to the list
+        of ignored files, since it's private.
+        * gtk/gtkdoc.py:
+        (GTKDoc._ignored_files_basenames): Helper function that returns a
+        string with the list of ignored files basenames separated by a
+        spaces, as expected by several gtkdoc commands.
+        (GTKDoc._run_gtkdoc_scan): Use _ignored_files_basenames for
+        --ignore-headers option.
+        (GTKDoc._run_gtkdoc_mkdb): Use _ignored_files_basenames for
+        --ignore-files option.
+
 2012-02-06  Carlos Garcia Campos  <cgarcia@igalia.com>
 

trunk/Tools/gtk/generate-gtkdoc

@@ -120 +120 @@
                    ' -I' + common.top_level_path('Source', 'JavaScriptCore', 'ForwardingHeaders'),
         'cross_reference_deps' : get_gtkdoc_module_paths(xref_deps),
-        'ignored_files': glob.glob(src_path('webkit', '*private.*'))
+        'ignored_files': glob.glob(src_path('webkit', '*private.*')) + \
+                         glob.glob(src_path('webkit', 'webkitspellcheckerenchant.*'))
     })
     return options

trunk/Tools/gtk/gtkdoc.py

@@ -257 +257 @@
         output_file.close()
 
+    def _ignored_files_basenames(self):
+        return ' '.join([os.path.basename(x) for x in self.ignored_files])
+
     def _run_gtkdoc_scan(self):
         args = ['gtkdoc-scan',
@@ -275 +278 @@
         # dirname. Different from "--source-dir", the headers should be
         # specified as one long string.
-        if self.ignored_files:
-            ignored_files_basenames = \
-                [os.path.basename(x) for x in self.ignored_files]
-            args.append('--ignore-headers=%s' % ' '.join(ignored_files_basenames))
+        ignored_files_basenames = self._ignored_files_basenames()
+        if ignored_files_basenames:
+            args.append('--ignore-headers=%s' % ignored_files_basenames)
 
         self._run_command(args)
@@ -321 +323 @@
                 '--output-format=xml',
                 '--sgml-mode']
+
+        ignored_files_basenames = self._ignored_files_basenames()
+        if ignored_files_basenames:
+            args.append('--ignore-files=%s' % ignored_files_basenames)
 
         # Each directory should be have its own "--source-dir=" prefix.