[GTK] Generate API documentation for GObject DOM bindings
authorcarlosgc@webkit.org <carlosgc@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 18 Oct 2013 10:33:26 +0000 (10:33 +0000)
committercarlosgc@webkit.org <carlosgc@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 18 Oct 2013 10:33:26 +0000 (10:33 +0000)
commit522fe480b0368088ed2323e524bd21b63c6e6772
treef0b5061567d3d6f4640f7ab06f5798406b129e2b
parent1c1b146a9f71f59e2b5041a6097ef43d635e067e
[GTK] Generate API documentation for GObject DOM bindings
https://bugs.webkit.org/show_bug.cgi?id=121538

Reviewed by Gustavo Noronha Silva.

.:

* GNUmakefile.am: Initialize gdom_symbol_files variable.

Source/WebCore:

* bindings/gobject/GNUmakefile.am: Add a explicit rule for all
.symbols file making them depend on the corresponding header file,
since the .symbols file is generated by the bindings generator.

Tools:

The .symbols file that is now generated for checking GObject DOM
bindings API compatibility while building can also be used to
generate the files needed to produce the gtk-doc
documentation. The new script generate-webkitdom-doc-files can
generate the docs.sgml and sections.txt files from the given list
of .symbols files.

* gtk/GNUmakefile.am: Add rules to generate webkitdomgtk-docs.sgml
and webkitdomgtk-sections.txt as well as rules to install the
generated WebKitDOMGTK documentation.
* gtk/generate-gtkdoc:
(webkitdom_docs_html_path): New helper function that returns the
path where the DOM API documentation has been generated.
(get_webkit2_options): Include DOM API docs to the list of xref
dependencies.
(get_webkit1_options): Ditto.
(get_webkitdom_options): Return the gtk-doc options to generate
the DOM API docs.
(get_webkitdom_options.derived_sources_path):
(get_webkitdom_options.src_path):
* gtk/generate-webkitdom-doc-files: Added.
(WebKitDOMDocGenerator):
(WebKitDOMDocGenerator.write_header):
(WebKitDOMDocGenerator.write_section):
(WebKitDOMDocGenerator.write_footer):
(WebKitDOMDocGeneratorDocs):
(WebKitDOMDocGeneratorDocs.write_header):
(write_section):
(write_footer):
(WebKitDOMDocGeneratorSections):
(WebKitDOMDocGeneratorSections.__init__):
(WebKitDOMDocGeneratorSections._dom_class):
(WebKitDOMDocGeneratorSections._dom_class_decamelize):
(WebKitDOMDocGeneratorSections._symbol_list):
(WebKitDOMDocGeneratorSections.write_section):

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@157630 268f45cc-cd09-0410-ab3c-d52691b4dbfc
ChangeLog
GNUmakefile.am
Source/WebCore/ChangeLog
Source/WebCore/bindings/gobject/GNUmakefile.am
Tools/ChangeLog
Tools/gtk/GNUmakefile.am
Tools/gtk/generate-gtkdoc
Tools/gtk/generate-webkitdom-doc-files [new file with mode: 0755]