summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorOlivier CrĂȘte <olivier.crete@collabora.com>2015-06-16 15:33:43 -0400
committerOlivier CrĂȘte <olivier.crete@collabora.com>2015-06-16 15:33:43 -0400
commitae939f4833849efb655ed629a3508304d0cf9c56 (patch)
tree7dc9fe9ad98681a57e9893c8d2f54d4c7dc83130 /doc
parent049f7973da3cab179293dc2920cdc8a082f2dfaf (diff)
downloadgupnp-igd-ae939f4833849efb655ed629a3508304d0cf9c56.tar.gz
Update GTK-Doc usage to 1.10
Diffstat (limited to 'doc')
-rw-r--r--doc/.gitignore1
-rw-r--r--doc/Makefile.am18
-rw-r--r--doc/gupnp-igd-docs.xml (renamed from doc/gupnp-igd-docs.sgml)5
-rw-r--r--doc/gupnp-igd-sections.txt2
-rw-r--r--doc/gupnp-igd.types2
5 files changed, 20 insertions, 8 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..fdcfe76
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1 @@
+gupnp-igd.types
diff --git a/doc/Makefile.am b/doc/Makefile.am
index de8e220..c869776 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -12,7 +12,7 @@ AUTOMAKE_OPTIONS = 1.6
DOC_MODULE=gupnp-igd
# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
# The directory containing the source code. Relative to $(srcdir).
# gtk-doc will search all .c & .h files beneath here for inline comments
@@ -25,11 +25,11 @@ SCANGOBJ_OPTIONS=
# Extra options to supply to gtkdoc-scan.
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=
+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=--xml-mode --output-format=xml
# Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
@@ -47,7 +47,9 @@ CFILE_GLOB=$(top_srcdir)/libgupnp-igd/*.c
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=$(top_srcdir)/libgupnp-igd/*marshal.h
+IGNORE_HFILES=$(top_srcdir)/libgupnp-igd/*marshal.h \
+ gupnp-simple-igd-priv.h \
+ gupnp-enum-types.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
@@ -82,8 +84,14 @@ EXTRA_DIST += version.xml.in
# Files not to distribute
# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-#DISTCLEANFILES +=
+DISTCLEANFILES = (DOC_MODULE).types
# Comment this out if you want your docs-status tested during 'make check'
# TESTS = $(GTKDOC_CHECK)
+if ENABLE_GTK_DOC
+TESTS_ENVIRONMENT = \
+ DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
+ SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
+TESTS = $(GTKDOC_CHECK)
+endif
diff --git a/doc/gupnp-igd-docs.sgml b/doc/gupnp-igd-docs.xml
index 33626d9..c29d1c1 100644
--- a/doc/gupnp-igd-docs.sgml
+++ b/doc/gupnp-igd-docs.xml
@@ -22,4 +22,9 @@
<xi:include href="xml/gupnp-simple-igd.xml"/>
<xi:include href="xml/gupnp-simple-igd-thread.xml"/>
</chapter>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ <chapter>
+ <title>Symbols index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </chapter>
</book>
diff --git a/doc/gupnp-igd-sections.txt b/doc/gupnp-igd-sections.txt
index 9c33684..f29be52 100644
--- a/doc/gupnp-igd-sections.txt
+++ b/doc/gupnp-igd-sections.txt
@@ -4,12 +4,12 @@
GUPnPSimpleIgd
GUPnPSimpleIgdClass
GUPNP_SIMPLE_IGD_ERROR
-GUPNP_TYPE_SIMPLE_IGD_ERROR
GUPnPSimpleIgdError
gupnp_simple_igd_new
gupnp_simple_igd_add_port
gupnp_simple_igd_remove_port
gupnp_simple_igd_delete_all_mappings
+gupnp_simple_igd_remove_port_local
<SUBSECTION Standard>
GUPNP_SIMPLE_IGD
GUPNP_SIMPLE_IGD_CLASS
diff --git a/doc/gupnp-igd.types b/doc/gupnp-igd.types
deleted file mode 100644
index 892d65f..0000000
--- a/doc/gupnp-igd.types
+++ /dev/null
@@ -1,2 +0,0 @@
-gupnp_simple_igd_get_type
-gupnp_simple_igd_thread_get_type