diff options
author | Aleksander Morgado <aleksander@lanedo.com> | 2012-10-01 14:08:40 +0200 |
---|---|---|
committer | Aleksander Morgado <aleksander@lanedo.com> | 2012-10-01 23:44:47 +0200 |
commit | ca14de0605c5d881c46dc43e77ce36d3c4bf6027 (patch) | |
tree | 2e2312e0e68d53f937940089076c9f7774ea443d /docs | |
parent | 54f476fe10e9683c19b50fc26b52ca648745fd9f (diff) |
doc: setup gtk-doc generation for libmm-glib
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/Makefile.am | 2 | ||||
-rw-r--r-- | docs/reference/libmm-glib/Makefile.am | 65 | ||||
-rw-r--r-- | docs/reference/libmm-glib/libmm-glib-docs.xml | 100 | ||||
-rw-r--r-- | docs/reference/libmm-glib/version.xml.in | 1 |
4 files changed, 167 insertions, 1 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 42627b5b..4facd1f8 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -1,2 +1,2 @@ -SUBDIRS = api +SUBDIRS = api libmm-glib diff --git a/docs/reference/libmm-glib/Makefile.am b/docs/reference/libmm-glib/Makefile.am new file mode 100644 index 00000000..f1ecbb26 --- /dev/null +++ b/docs/reference/libmm-glib/Makefile.am @@ -0,0 +1,65 @@ + +# The name of the module. +DOC_MODULE = libmm-glib + +# The top-level SGML file. +DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS = + +# The directory containing the source code. +DOC_SOURCE_DIR = $(top_srcdir)/libmm-glib + +HFILE_GLOB = +CFILE_GLOB = + +# Headers to ignore +IGNORE_HFILES = \ + mm-helpers.h \ + $(NULL) + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +INCLUDES = \ + -I$(srcdir) \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + $(MM_CFLAGS) \ + $(NULL) + +GTKDOC_LIBS = \ + $(top_builddir)/libmm-glib/libmm-glib.la \ + $(MM_LIBS) \ + $(NULL) + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS = --output-format=xml --sgml-mode --name-space=mm + +if ENABLE_GTK_DOC +include $(top_srcdir)/gtk-doc.make +else +EXTRA_DIST = +CLEANFILES = +endif + +EXTRA_DIST += \ + version.xml.in \ + $(NULL) + +CLEANFILES += \ + $(DOC_MODULE)-decl-list.txt \ + $(DOC_MODULE)-decl.txt \ + $(DOC_MODULE)-overrides.txt \ + $(DOC_MODULE)-undeclared.txt \ + $(DOC_MODULE)-undocumented.txt \ + $(DOC_MODULE)-overrides.txt \ + $(DOC_MODULE)-unused.txt \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).interfaces \ + $(DOC_MODULE).prerequisites \ + $(DOC_MODULE).signals \ + *.stamp \ + -rf xml html tmpl \ + $(NULL) diff --git a/docs/reference/libmm-glib/libmm-glib-docs.xml b/docs/reference/libmm-glib/libmm-glib-docs.xml new file mode 100644 index 00000000..9468c88b --- /dev/null +++ b/docs/reference/libmm-glib/libmm-glib-docs.xml @@ -0,0 +1,100 @@ +<?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 version SYSTEM "version.xml"> +]> +<book id="libmm-glib" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>libmm-glib Reference Manual</title> + <releaseinfo>For libmm-glib version &version;</releaseinfo> + + <authorgroup> + <author> + <firstname>Aleksander</firstname> + <surname>Morgado</surname> + <affiliation> + <address> + <email>aleksander@lanedo.com</email> + </address> + </affiliation> + </author> + </authorgroup> + + <copyright> + <year>2011</year> + <year>2012</year> + <holder>The ModemManager 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.3 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>, Suite 500 + <city>Boston</city>, <state>MA</state> <postcode>02110-1335</postcode> + <country>USA</country> + </address> + </para> + </legalnotice> + </bookinfo> + + <chapter> + <title>The Manager object</title> + <xi:include href="xml/mm-manager.xml"/> + </chapter> + + <chapter> + <title>The Modem object</title> + <xi:include href="xml/mm-object.xml"/> + <xi:include href="xml/mm-modem.xml"/> + <xi:include href="xml/mm-modem-3gpp.xml"/> + <xi:include href="xml/mm-modem-3gpp-ussd.xml"/> + <xi:include href="xml/mm-modem-cdma.xml"/> + <xi:include href="xml/mm-modem-location.xml"/> + <xi:include href="xml/mm-modem-messaging.xml"/> + <xi:include href="xml/mm-modem-time.xml"/> + <xi:include href="xml/mm-modem-simple.xml"/> + </chapter> + + <chapter> + <title>The Bearer object</title> + <xi:include href="xml/mm-bearer.xml"/> + </chapter> + + <chapter> + <title>The SIM object</title> + <xi:include href="xml/mm-sim.xml"/> + </chapter> + + <chapter> + <title>The SMS object</title> + <xi:include href="xml/mm-sms.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> diff --git a/docs/reference/libmm-glib/version.xml.in b/docs/reference/libmm-glib/version.xml.in new file mode 100644 index 00000000..d78bda93 --- /dev/null +++ b/docs/reference/libmm-glib/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |