GNOME.org
 

[gupnp-igd] Update GTK-Doc usage to 1.10

commit ae939f4833849efb655ed629a3508304d0cf9c56
Author: Olivier Crête <olivier crete collabora com>
Date:   Tue Jun 16 15:33:43 2015 -0400

    Update GTK-Doc usage to 1.10

 .gitignore                                      |    5 +++++
 configure.ac                                    |    2 +-
 doc/.gitignore                                  |    1 +
 doc/Makefile.am                                 |   18 +++++++++++++-----
 doc/{gupnp-igd-docs.sgml => gupnp-igd-docs.xml} |    5 +++++
 doc/gupnp-igd-sections.txt                      |    2 +-
 doc/gupnp-igd.types                             |    2 --
 libgupnp-igd/gupnp-simple-igd-priv.h            |    3 ++-
 libgupnp-igd/gupnp-simple-igd-thread.c          |    1 -
 libgupnp-igd/gupnp-simple-igd.h                 |    6 ++++++
 10 files changed, 34 insertions(+), 11 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index 33c5bd4..5d1bc99 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,6 +12,9 @@ Makefile.in
 *.stamp
 *.gir
 *.typelib
+*.log
+*.trs
+*.test
 
 aclocal.m4
 autom4te.cache
@@ -31,8 +34,10 @@ libtool
 ltmain.sh
 mkinstalldirs
 missing
+py-compile
 stamp-h.in
 stamp-h1
+test-driver
 
 gtk-doc.make
 gupnp-igd-1.0-uninstalled.pc
diff --git a/configure.ac b/configure.ac
index 2b80804..effa1c3 100644
--- a/configure.ac
+++ b/configure.ac
@@ -22,7 +22,7 @@ m4_ifdef([AM_SILENT_RULES],[AM_SILENT_RULES([yes])],
   [AM_DEFAULT_VERBOSITY=1
    AC_SUBST(AM_DEFAULT_VERBOSITY)])
 
-GTK_DOC_CHECK([1.0])
+GTK_DOC_CHECK([1.10],[--flavour no-tmpl])
 
 AC_DEFINE([GLIB_VERSION_MIN_REQUIRED], [GLIB_VERSION_2_26], [Version 2.26 is required])
 AC_DEFINE([GLIB_VERSION_MAX_ALLOWED], [GLIB_VERSION_2_26], [Ignore post 2.26 deprecations])
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
similarity index 77%
rename from doc/gupnp-igd-docs.sgml
rename to 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/libgupnp-igd/gupnp-simple-igd-priv.h b/libgupnp-igd/gupnp-simple-igd-priv.h
index 0081b78..38ea792 100644
--- a/libgupnp-igd/gupnp-simple-igd-priv.h
+++ b/libgupnp-igd/gupnp-simple-igd-priv.h
@@ -27,9 +27,10 @@
 
 /**
  * GUPnPSimpleIgdClass:
- * @parent_class: Our parent
+
  * @add_port: An implementation of the add_port function
  * @remove_port: An implementation of the delete_port function
+ * @remove_local_port: An implementation of the remove_local_port function
  *
  * The Raw UDP component transmitter class
  */
diff --git a/libgupnp-igd/gupnp-simple-igd-thread.c b/libgupnp-igd/gupnp-simple-igd-thread.c
index 178c9f2..8212f76 100644
--- a/libgupnp-igd/gupnp-simple-igd-thread.c
+++ b/libgupnp-igd/gupnp-simple-igd-thread.c
@@ -40,7 +40,6 @@
 
 /**
  * GUPnPSimpleIgdThreadClass:
- * @parent_class: Our parent
  *
  * The Raw UDP component transmitter class
  */
diff --git a/libgupnp-igd/gupnp-simple-igd.h b/libgupnp-igd/gupnp-simple-igd.h
index d0acd8f..8122642 100644
--- a/libgupnp-igd/gupnp-simple-igd.h
+++ b/libgupnp-igd/gupnp-simple-igd.h
@@ -65,6 +65,12 @@ struct _GUPnPSimpleIgd
   GUPnPSimpleIgdPrivate *priv;
 };
 
+/**
+ * GUPNP_SIMPLE_IGD_ERROR:
+ *
+ * The error domain for GUPnP Simple IGD
+ */
+
 #define GUPNP_SIMPLE_IGD_ERROR (gupnp_simple_igd_error_quark ())
 
 /**
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]