diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 30 | ||||
-rw-r--r-- | doc/connman-docs.xml | 79 | ||||
-rw-r--r-- | doc/connman-introduction.xml | 15 |
3 files changed, 122 insertions, 2 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 62aa9bce..de2b0918 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,30 @@ -EXTRA_DIST = manager-api.txt element-api.txt agent-api.txt plugin-api.txt +DOC_MODULE = connman -MAINTAINERCLEANFILES = Makefile.in +DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml + +DOC_SOURCE_DIR = ../src + +MKDB_OPTIONS = --sgml-mode --output-format=xml --tmpl-dir=. + +MKTMPL_OPTIONS = --output-dir=. + +HFILE_GLOB = $(top_srcdir)/include/*.h +CFILE_GLOB = $(top_srcdir)/src/*.c + +IGNORE_HFILES = config.h connman.h + +HTML_IMAGES = + +content_files = version.xml connman-introduction.xml + +INCLUDES = -I$(top_srcdir) $(GLIB_CFLAGS) $(DBUS_CFLAGS) + +GTKDOC_LIBS = + +MAINTAINERCLEANFILES = Makefile.in \ + $(DOC_MODULE).types $(DOC_MODULE)-*.sgml $(DOC_MODULE)-*.txt + +include $(top_srcdir)/doc/gtk-doc.make + +EXTRA_DIST += manager-api.txt element-api.txt agent-api.txt plugin-api.txt diff --git a/doc/connman-docs.xml b/doc/connman-docs.xml new file mode 100644 index 00000000..fea3fc0b --- /dev/null +++ b/doc/connman-docs.xml @@ -0,0 +1,79 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +<!ENTITY version SYSTEM "version.xml"> +]> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>Connection Manager Reference Manual</title> + <releaseinfo>Version &version;</releaseinfo> + <authorgroup> + <author> + <firstname>Marcel</firstname> + <surname>Holtmann</surname> + <affiliation> + <address> + <email>marcel@holtmann.org</email> + </address> + </affiliation> + </author> + </authorgroup> + + <copyright> + <year>2007-2008</year> + <holder>Intel Corporation. All rights reserved.</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>59 Temple Place</street> - Suite 330, + <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>, + <country>USA</country> + </address> + </para> + </legalnotice> + </bookinfo> + + <reference id="design"> + <title>Design Overview</title> + <partintro> + <para> + This part presents the design documentation for Connection Manager. + </para> + </partintro> + <xi:include href="connman-introduction.xml" /> + </reference> + + <reference id="reference"> + <title>API Reference</title> + <partintro> + <para> + This part presents the function reference for Connection Manager. + </para> + </partintro> + </reference> + + <index> + <title>Index</title> + </index> + + <appendix id="license"> + <title>License</title> + <para> +<programlisting><xi:include href="../COPYING" parse="text" /></programlisting> + </para> + </appendix> +</book> diff --git a/doc/connman-introduction.xml b/doc/connman-introduction.xml new file mode 100644 index 00000000..4672c2c7 --- /dev/null +++ b/doc/connman-introduction.xml @@ -0,0 +1,15 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> + +<chapter id="introduction"> + <title>Introduction</title> + + <sect1 id="intro-about"> + <title>About</title> + + <para> + </para> + </sect1> + +</chapter> |