Modified: trunk/Tools/ChangeLog (158907 => 158908)
--- trunk/Tools/ChangeLog 2013-11-08 08:09:23 UTC (rev 158907)
+++ trunk/Tools/ChangeLog 2013-11-08 08:12:09 UTC (rev 158908)
@@ -1,3 +1,21 @@
+2013-11-08 Carlos Garcia Campos <[email protected]>
+
+ [GTK] Pass the library namespace to gtkdoc-mkdb
+ https://bugs.webkit.org/show_bug.cgi?id=123900
+
+ Reviewed by Martin Robinson.
+
+ This fixes the generation of the index of symbols in the API
+ documentation.
+
+ * gtk/generate-gtkdoc:
+ (get_webkit2_options): Define namespace as WebKit.
+ (get_webkit1_options): Ditto.
+ (get_webkitdom_options): Define namespace as WebKitDOM.
+ * gtk/gtkdoc.py:
+ (GTKDoc.__init__): Add namespace option.
+ (GTKDoc._run_gtkdoc_mkdb): Pass namespace to mkdb if present.
+
2013-11-07 Chris Fleizach <[email protected]>
Modify email order list for James Craig so his primary email is first.
Modified: trunk/Tools/gtk/generate-gtkdoc (158907 => 158908)
--- trunk/Tools/gtk/generate-gtkdoc 2013-11-08 08:09:23 UTC (rev 158907)
+++ trunk/Tools/gtk/generate-gtkdoc 2013-11-08 08:12:09 UTC (rev 158908)
@@ -91,6 +91,7 @@
options = get_common_options().copy()
options.update({
'module_name' : 'webkit2gtk',
+ 'namespace' : 'WebKit',
'doc_dir' : src_path('docs'),
'output_dir' : common.build_path('Documentation', 'webkit2gtk'),
'source_dirs' : [src_path(), derived_sources_path('webkit2gtk', 'webkit2'), injected_bundle_src_path()],
@@ -131,6 +132,7 @@
options = get_common_options().copy()
options.update({
'module_name' : 'webkitgtk',
+ 'namespace' : 'WebKit',
'doc_dir' : src_path('docs'),
'output_dir' : common.build_path('Documentation', 'webkitgtk'),
'source_dirs' : [src_path('webkit'), common.build_path('Source', 'WebKit', 'gtk', 'webkit')],
@@ -157,6 +159,7 @@
options = get_common_options().copy()
options.update({
'module_name' : 'webkitdomgtk',
+ 'namespace' : 'WebKitDOM',
'doc_dir' : derived_sources_path('docs'),
'output_dir' : common.build_path('Documentation', 'webkitdomgtk'),
'source_dirs' : [derived_sources_path()],
Modified: trunk/Tools/gtk/gtkdoc.py (158907 => 158908)
--- trunk/Tools/gtk/gtkdoc.py 2013-11-08 08:09:23 UTC (rev 158907)
+++ trunk/Tools/gtk/gtkdoc.py 2013-11-08 08:12:09 UTC (rev 158908)
@@ -43,6 +43,7 @@
only necessary to provide the basenames of these files.
Typically it is important to provide an updated list of
ignored files to prevent warnings about undocumented symbols.
+ namespace -- The library namespace.
decorator -- If a decorator is used to unhide certain symbols in header
files this parameter is required for successful scanning.
(default '')
@@ -87,6 +88,7 @@
self.module_name = ''
self.source_dirs = []
self.ignored_files = []
+ self.namespace = ''
self.decorator = ''
self.deprecation_guard = ''
@@ -331,6 +333,9 @@
'--output-format=xml',
'--sgml-mode']
+ if self.namespace:
+ args.append('--name-space=%s' % self.namespace)
+
ignored_files_basenames = self._ignored_files_basenames()
if ignored_files_basenames:
args.append('--ignore-files=%s' % ignored_files_basenames)