[network-manager-applet/lr/gtk-doc: 3/4] libnma: add gtk-doc documentation

[Lubomir Rintel <lkundrak src gnome org>]

commit bca304512a3852155d656608e4027746afa7837a
Author: Lubomir Rintel <lkundrak v3 sk>
Date:   Thu Mar 2 15:14:21 2017 +0100

    libnma: add gtk-doc documentation

 .gitignore      |   17 +++++++++++++
 Makefile.am     |   31 +++++++++++++++++++++---
 autogen.sh      |    1 +
 configure.ac    |    5 ++++
 libnma-docs.xml |   71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 121 insertions(+), 4 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index 73c4735..611dc9e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -72,3 +72,20 @@ man/*.1
 /test-driver
 **/tests/test-*.log
 **/tests/test-*.trs
+
+xml/
+html/
+gtk-doc.make
+libnma-decl-list.txt
+libnma-decl.txt
+libnma-overrides.txt
+libnma-sections.txt
+libnma-undeclared.txt
+libnma-undocumented.txt
+libnma-unused.txt
+libnma.args
+libnma.hierarchy
+libnma.interfaces
+libnma.prerequisites
+libnma.signals
+libnma.types
diff --git a/Makefile.am b/Makefile.am
index cba532f..a57e15f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,5 +1,6 @@
 include $(GLIB_MAKEFILE)
 -include $(INTROSPECTION_MAKEFILE)
+include $(top_srcdir)/gtk-doc.make
 
 ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
 
@@ -23,10 +24,6 @@ check_local =
 
 TESTS =
 
-EXTRA_DIST =
-
-CLEANFILES =
-
 DISTCLEANFILES =
 
 DISTCHECK_CONFIGURE_FLAGS = \
@@ -832,6 +829,32 @@ man_MANS += \
 
 ###############################################################################
 
+DOC_MODULE = libnma
+
+DOC_SOURCE_DIR = $(top_srcdir)/src/libnma
+
+SCAN_OPTIONS=--rebuild-types --rebuild-sections
+
+DOC_MAIN_SGML_FILE = libnma-docs.xml
+
+GTKDOC_LIBS = src/libnma/libnma.la
+
+scan-build.stamp: $(GTKDOC_LIBS)
+
+HFILE_GLOB = $(top_srcdir)/src/libnma/*.h
+
+CFILE_GLOB = $(top_srcdir)/src/libnma/*.c
+
+IGNORE_HFILES = \
+       nma-resources.h
+
+mkdb_ignore_c_files = \
+       nma-resources.c
+
+MKDB_OPTIONS = --ignore-files "$(IGNORE_HFILES) $(mkdb_ignore_c_files)"
+
+###############################################################################
+
 check_PROGRAMS += $(check_programs)
 
 check-local: $(check_local)
diff --git a/autogen.sh b/autogen.sh
index 53705a1..d783df0 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -14,6 +14,7 @@ PKG_NAME=nm-applet
 }
 
 (cd $srcdir;
+    gtkdocize &&
     autoreconf --install --symlink &&
     intltoolize --force &&
     autoreconf
diff --git a/configure.ac b/configure.ac
index 3e4a3dd..dc6fdc2 100644
--- a/configure.ac
+++ b/configure.ac
@@ -71,6 +71,11 @@ else
     AC_DEFINE_UNQUOTED([ISO_CODES_PREFIX],["$prefix"],[ISO codes prefix])
 fi
 
+dnl
+dnl API documentation
+dnl
+GTK_DOC_CHECK(1.0)
+
 AC_ARG_WITH(libnm-gtk, AS_HELP_STRING([--without-libnm-gtk], [dont build legacy library libnm-gtk which 
depends on libnm-glib/libnm-util/dbus-glib]))
 if test "$with_libnm_gtk" != no; then
        PKG_CHECK_MODULES(LIBNM_GLIB,
diff --git a/libnma-docs.xml b/libnma-docs.xml
new file mode 100644
index 0000000..b043c74
--- /dev/null
+++ b/libnma-docs.xml
@@ -0,0 +1,71 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
+  %gtkdocentities;
+]>
+<book id="index">
+  <bookinfo>
+    <title>libnma Reference Manual</title>
+    <releaseinfo>
+      for libnma &package_version;.
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" 
url="https://developer.gnome.org/libnma/index.html";>https://developer.gnome.org/libnma/</ulink>.
+    </releaseinfo>
+
+    <copyright>
+ ]    <year>2017</year>
+      <holder>The &package_tarname; Authors</holder>
+    </copyright>
+
+    <legalnotice>
+      <para>
+        Permission is granted to copy, distribute and/or modify this
+        document under the terms of the <citetitle>GNU Free
+        Documentation License</citetitle>, Version 1.1 or any later
+        version published by the Free Software Foundation with no
+        Invariant Sections, no Front-Cover Texts, and no Back-Cover
+        Texts. You may obtain a copy of the <citetitle>GNU Free
+        Documentation License</citetitle> from the Free Software
+        Foundation by visiting <ulink type="http"
+        url="http://www.fsf.org";>their Web site</ulink> or by writing
+        to:
+
+        <address>
+          The Free Software Foundation, Inc.,
+          <street>51 Franklin Street</street> - Fifth Floor,
+          <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
+          <country>USA</country>
+        </address>
+      </para>
+    </legalnotice>
+  </bookinfo>
+
+  <chapter id="api-reference">
+    <title>libnma API reference</title>
+    <xi:include href="xml/nma-mobile-providers.xml"/>
+    <xi:include href="xml/nma-mobile-wizard.xml"/>
+    <xi:include href="xml/nma-ui-utils.xml"/>
+    <xi:include href="xml/nma-vpn-password-dialog.xml"/>
+    <xi:include href="xml/nma-wifi-dialog.xml"/>
+  </chapter>
+
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+    <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>