- Revision
- 106788
- Author
- carlo...@webkit.org
- Date
- 2012-02-06 01:29:34 -0800 (Mon, 06 Feb 2012)
Log 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.
Modified Paths
Diff
Modified: trunk/Source/WebKit/gtk/ChangeLog (106787 => 106788)
--- trunk/Source/WebKit/gtk/ChangeLog 2012-02-06 09:27:50 UTC (rev 106787)
+++ trunk/Source/WebKit/gtk/ChangeLog 2012-02-06 09:29:34 UTC (rev 106788)
@@ -1,3 +1,18 @@
+2012-02-06 Carlos Garcia Campos <cgar...@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 <kalevlem...@gmail.com>
[GTK] Don't use uint
Modified: trunk/Source/WebKit/gtk/docs/webkitgtk-docs.sgml (106787 => 106788)
--- trunk/Source/WebKit/gtk/docs/webkitgtk-docs.sgml 2012-02-06 09:27:50 UTC (rev 106787)
+++ trunk/Source/WebKit/gtk/docs/webkitgtk-docs.sgml 2012-02-06 09:29:34 UTC (rev 106788)
@@ -40,7 +40,6 @@
<xi:include href=""
<xi:include href=""
<xi:include href=""
- <xi:include href=""
</chapter>
<chapter>
Modified: trunk/Source/WebKit/gtk/docs/webkitgtk-sections.txt (106787 => 106788)
--- trunk/Source/WebKit/gtk/docs/webkitgtk-sections.txt 2012-02-06 09:27:50 UTC (rev 106787)
+++ trunk/Source/WebKit/gtk/docs/webkitgtk-sections.txt 2012-02-06 09:29:34 UTC (rev 106788)
@@ -292,6 +292,7 @@
<FILE>webkitwebnavigationaction</FILE>
<TITLE>WebKitWebNavigationAction</TITLE>
WebKitWebNavigationAction
+WebKitWebNavigationReason
webkit_web_navigation_action_get_button
webkit_web_navigation_action_get_modifier_state
webkit_web_navigation_action_get_original_uri
@@ -307,7 +308,6 @@
WEBKIT_WEB_NAVIGATION_ACTION_CLASS
WEBKIT_WEB_NAVIGATION_ACTION_GET_CLASS
<SUBSECTION Private>
-WebKitWebNavigationReason
WebKitWebNavigationActionClass
WebKitWebNavigationActionPrivate
webkit_web_navigation_action_get_type
@@ -639,23 +639,6 @@
</SECTION>
<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
WEBKIT_PLUGIN_ERROR
Modified: trunk/Source/WebKit/gtk/webkit/webkitwebnavigationaction.h (106787 => 106788)
--- trunk/Source/WebKit/gtk/webkit/webkitwebnavigationaction.h 2012-02-06 09:27:50 UTC (rev 106787)
+++ trunk/Source/WebKit/gtk/webkit/webkitwebnavigationaction.h 2012-02-06 09:29:34 UTC (rev 106788)
@@ -26,9 +26,16 @@
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 {
WEBKIT_WEB_NAVIGATION_REASON_LINK_CLICKED,
Modified: trunk/Source/WebKit2/ChangeLog (106787 => 106788)
--- trunk/Source/WebKit2/ChangeLog 2012-02-06 09:27:50 UTC (rev 106787)
+++ trunk/Source/WebKit2/ChangeLog 2012-02-06 09:29:34 UTC (rev 106788)
@@ -1,3 +1,13 @@
+2012-02-06 Carlos Garcia Campos <cgar...@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 <m...@apple.com>
<rdar://problem/10809525> WebKit2’s WebFrameLoaderClient::shouldUseCredentialStorage() always returns true
Modified: trunk/Source/WebKit2/UIProcess/API/gtk/WebKitWindowProperties.cpp (106787 => 106788)
--- trunk/Source/WebKit2/UIProcess/API/gtk/WebKitWindowProperties.cpp 2012-02-06 09:27:50 UTC (rev 106787)
+++ trunk/Source/WebKit2/UIProcess/API/gtk/WebKitWindowProperties.cpp 2012-02-06 09:29:34 UTC (rev 106788)
@@ -38,7 +38,7 @@
* scrollbar, statusbar, locationbar should be visible to the user,
* 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.
*
Modified: trunk/Tools/ChangeLog (106787 => 106788)
--- trunk/Tools/ChangeLog 2012-02-06 09:27:50 UTC (rev 106787)
+++ trunk/Tools/ChangeLog 2012-02-06 09:29:34 UTC (rev 106788)
@@ -1,5 +1,24 @@
2012-02-06 Carlos Garcia Campos <cgar...@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 <cgar...@igalia.com>
+
[GTK] Fix xrefs after installing API documentation
https://bugs.webkit.org/show_bug.cgi?id=77551
Modified: trunk/Tools/gtk/generate-gtkdoc (106787 => 106788)
--- trunk/Tools/gtk/generate-gtkdoc 2012-02-06 09:27:50 UTC (rev 106787)
+++ trunk/Tools/gtk/generate-gtkdoc 2012-02-06 09:29:34 UTC (rev 106788)
@@ -119,7 +119,8 @@
' -I' + common.top_level_path('Source') + \
' -I' + common.top_level_path('Source', '_javascript_Core', '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
Modified: trunk/Tools/gtk/gtkdoc.py (106787 => 106788)
--- trunk/Tools/gtk/gtkdoc.py 2012-02-06 09:27:50 UTC (rev 106787)
+++ trunk/Tools/gtk/gtkdoc.py 2012-02-06 09:29:34 UTC (rev 106788)
@@ -256,6 +256,9 @@
output_file.write(self.version)
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',
'--module=%s' % self.module_name,
@@ -274,10 +277,9 @@
# gtkdoc-scan wants the basenames of ignored headers, so strip the
# 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,6 +323,10 @@
'--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.
args.extend(['--source-dir=%s' % path for path in self.source_dirs])
self._run_command(args, cwd=self.output_dir)
