diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2008-08-14 01:25:48 +0200 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2008-08-14 01:25:48 +0200 |
| commit | a6d8f4bb835dc01344861e26b78867273322cb52 (patch) | |
| tree | 36c4cea88536c8015563abf2991d8313966af229 /doc | |
| parent | b5fc727db22139bb3f28367d1f31f241ccc1e236 (diff) | |
| download | connman-a6d8f4bb835dc01344861e26b78867273322cb52.tar.gz connman-a6d8f4bb835dc01344861e26b78867273322cb52.tar.bz2 connman-a6d8f4bb835dc01344861e26b78867273322cb52.zip | |
First steps into providing API documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 19 | ||||
| -rw-r--r-- | doc/connman-docs.xml | 2 |
2 files changed, 15 insertions, 6 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index c7b59b68..a2e92058 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -5,25 +5,32 @@ DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml DOC_SOURCE_DIR = ../src -MKDB_OPTIONS = --sgml-mode --output-format=xml --tmpl-dir=. +SCAN_OPTIONS = --rebuild-sections --source-dir=../include + +MKDB_OPTIONS = --sgml-mode --output-format=xml --tmpl-dir=. \ + --ignore-files=connman \ + --source-dir=../include \ + --source-suffixes=c,h MKTMPL_OPTIONS = --output-dir=. HFILE_GLOB = $(top_srcdir)/include/*.h -CFILE_GLOB = $(top_srcdir)/src/*.c +CFILE_GLOB = $(top_srcdir)/src/*.c $(top_srcdir)/src/*.h -IGNORE_HFILES = config.h connman.h +IGNORE_HFILES = connman connman.h supplicant.h \ + iface.h rtnl.h dbus.h element.h property.h driver.h security.h HTML_IMAGES = content_files = connman-introduction.xml -INCLUDES = -I$(top_srcdir) $(GLIB_CFLAGS) $(DBUS_CFLAGS) +INCLUDES = -I$(top_srcdir)/include -I$(top_srcdir)/gdbus \ + $(GTHREAD_CFLAGS) $(GMODULE_CFLAGS) $(GLIB_CFLAGS) $(DBUS_CFLAGS) -GTKDOC_LIBS = +GTKDOC_LIBS = $(DBUS_LIBS) $(GLIB_LIBS) $(GMODULE_LIBS) $(GTHREAD_LIBS) MAINTAINERCLEANFILES = Makefile.in \ - $(DOC_MODULE).types $(DOC_MODULE)-*.sgml $(DOC_MODULE)-*.txt + $(DOC_MODULE).types $(DOC_MODULE)-*.txt *.sgml if ENABLE_GTK_DOC include $(top_srcdir)/doc/gtk-doc.make diff --git a/doc/connman-docs.xml b/doc/connman-docs.xml index d070a3d6..4674a627 100644 --- a/doc/connman-docs.xml +++ b/doc/connman-docs.xml @@ -64,6 +64,8 @@ This part presents the function reference for Connection Manager. </para> </partintro> + <xi:include href="xml/log.xml" /> + <xi:include href="xml/plugin.xml" /> </reference> <appendix id="license"> |