gtk-doc for libmmanager-gtk.
authorCosimo Cecchi <cosimoc@gnome.org>
Sat, 2 Aug 2008 09:56:33 +0000 (2 11:56 +0200)
committerCosimo Cecchi <cosimoc@gnome.org>
Sat, 2 Aug 2008 09:56:33 +0000 (2 11:56 +0200)
docs/libmmanager-gtk/Makefile.am [new file with mode: 0644]
docs/libmmanager-gtk/libmmanager-gtk-docs.sgml [new file with mode: 0644]

diff --git a/docs/libmmanager-gtk/Makefile.am b/docs/libmmanager-gtk/Makefile.am
new file mode 100644 (file)
index 0000000..2082775
--- /dev/null
@@ -0,0 +1,42 @@
+# The name of the module.
+DOC_MODULE=libmmanager-gtk
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# Extra options to supply to gtkdoc-scan
+SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED"
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=$(top_srcdir)/libmmanager-gtk
+
+HFILE_GLOB=$(top_srcdir)/libmmanager-gtk/*.h
+CFILE_GLOB=$(top_srcdir)/libmmanager-gtk/*.c
+
+# Headers to ignore
+IGNORE_HFILES= \
+       mm-gtk.h
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+GTKDOC_CFLAGS =                                \
+       -I$(srcdir)                             \
+       -I$(top_srcdir)                         \
+       -I$(top_srcdir)/libmmanager-gtk         \
+       -I$(top_builddir)                       \
+       -I$(top_builddir)/libmmanager-gtk       \
+       $(MMEDIAMANAGER_CFLAGS)
+
+GTKDOC_LIBS =                                                  \
+       $(top_builddir)/libmmanager-gtk/libmmanager-gtk.la      \
+       $(top_builddir)/libmmanager/libmmanager.la              \
+       $(MEDIAMANAGER_LIBS)
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS = --output-format=xml --sgml-mode
+
+# Images to copy into HTML directory
+HTML_IMAGES =
+
+include $(top_srcdir)/gtk-doc.make
+
diff --git a/docs/libmmanager-gtk/libmmanager-gtk-docs.sgml b/docs/libmmanager-gtk/libmmanager-gtk-docs.sgml
new file mode 100644 (file)
index 0000000..0a38868
--- /dev/null
@@ -0,0 +1,36 @@
+<?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 lang="en" id="libmmanager" xmlns:xi="http://www.w3.org/2003/XInclude">
+<title>libmmanager-gtk Reference Manual</title>
+  <bookinfo>
+    <title>libmmanager-gtk Reference Manual</title>
+    <releaseinfo>for libmmanager-gtk</releaseinfo>
+  </bookinfo>
+  <part>
+  <title>libmmanager-gtk Overview</title>
+  </part>
+  <part>
+  <title>API Reference</title>
+    <chapter id="libmmanager-gtk_api">
+      <title>libmmanager API reference</title>
+      <xi:include href="xml/mm-gtk-application-store.xml"/>
+      <xi:include href="xml/mm-gtk-application-view.xml"/>
+      <xi:include href="xml/mm-gtk-attribute-store.xml"/>
+      <xi:include href="xml/mm-gtk-filter-builder.xml"/>
+      <xi:include href="xml/mm-gtk-hit-store.xml"/>
+      <xi:include href="xml/mm-gtk-hit-view.xml"/>
+    </chapter>
+  </part>
+
+  <chapter id="libmmanager-gtk-hierarchy">
+    <title>Object Hierarchy</title>
+      <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+
+  <index>
+    <title id="index-all">Index</title>
+  </index>
+</book>