summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Mayo <aklhfex@gmail.com>2015-11-28 10:26:08 +0000
committerLionel Landwerlin <llandwerlin@gmail.com>2015-12-10 23:47:46 +0000
commit0d2d02660f3ed69bfb2123baed9d150888878f05 (patch)
tree8ade6ba2d20411226d49a7b360c7b2401938b0bf
parent20ecf08fdeec224a9921fa41cb070285c6b33a2f (diff)
downloadclutter-gst-0d2d02660f3ed69bfb2123baed9d150888878f05.tar.gz
documentation: add API indices
Generate index sections by adding name-space to MKDB_OPTIONS Signed-off-by: Chris Mayo <aklhfex@gmail.com> https://bugzilla.gnome.org/show_bug.cgi?id=758768
-rw-r--r--doc/reference/Makefile.am2
-rw-r--r--doc/reference/clutter-gst-docs.sgml17
2 files changed, 18 insertions, 1 deletions
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 9b76863..7b46775 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -31,7 +31,7 @@ SCAN_OPTIONS=--rebuild-types
# Extra options to supply to gtkdoc-mkdb.
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=clutter_gst
# Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
diff --git a/doc/reference/clutter-gst-docs.sgml b/doc/reference/clutter-gst-docs.sgml
index 567c2c6..9a75c8b 100644
--- a/doc/reference/clutter-gst-docs.sgml
+++ b/doc/reference/clutter-gst-docs.sgml
@@ -79,6 +79,23 @@
<xi:include href="xml/clutter-gst-version.xml"/>
</chapter>
+ <index id="api-index-all">
+ <title>Index of all symbols</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-1-4" role="1.4">
+ <title>Index of new symbols in 1.4</title>
+ <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-1-6" role="1.6">
+ <title>Index of new symbols in 1.6</title>
+ <xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-3-0" role="3.0">
+ <title>Index of new symbols in 3.0</title>
+ <xi:include href="xml/api-index-3.0.xml"><xi:fallback /></xi:include>
+ </index>
+
<appendix id="license">
<title>License</title>