diff --git a/.gitignore b/.gitignore index 46bc9149..3f9c1418 100644 --- a/.gitignore +++ b/.gitignore @@ -90,6 +90,19 @@ docs/reference/api/tmpl docs/reference/api/xml docs/reference/api/*.png +docs/reference/libmm-glib/version.xml +docs/reference/libmm-glib/libmm-glib.args +docs/reference/libmm-glib/libmm-glib.hierarchy +docs/reference/libmm-glib/libmm-glib.interfaces +docs/reference/libmm-glib/libmm-glib.prerequisites +docs/reference/libmm-glib/libmm-glib.signals +docs/reference/libmm-glib/libmm-glib.types +docs/reference/libmm-glib/*.stamp +docs/reference/libmm-glib/*.txt +docs/reference/libmm-glib/html +docs/reference/libmm-glib/tmpl +docs/reference/libmm-glib/xml + docs/man/ModemManager.8 m4/gtk-doc.m4 diff --git a/configure.ac b/configure.ac index 21bbe547..d32ca7c1 100644 --- a/configure.ac +++ b/configure.ac @@ -247,6 +247,8 @@ docs/man/ModemManager.8 docs/reference/Makefile docs/reference/api/Makefile docs/reference/api/version.xml +docs/reference/libmm-glib/Makefile +docs/reference/libmm-glib/version.xml libmm-glib/Makefile cli/Makefile ]) 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 @@ + + +]> + + + libmm-glib Reference Manual + For libmm-glib version &version; + + + + Aleksander + Morgado + +
+ aleksander@lanedo.com +
+
+
+
+ + + 2011 + 2012 + The ModemManager Authors + + + + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free + Documentation License, 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 GNU Free + Documentation License from the Free Software + Foundation by visiting their Web site or by writing + to: +
+ The Free Software Foundation, Inc. + 51 Franklin Street, Suite 500 + Boston, MA 02110-1335 + USA +
+
+
+
+ + + The Manager object + + + + + The Modem object + + + + + + + + + + + + + The Bearer object + + + + + The SIM object + + + + + The SMS object + + + + + Object Hierarchy + + + + + API Index + + + + + Index of deprecated API + + + + +
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@