doc: Build documentation using gtk-doc

5 files changed, 220 insertions, 0 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..f847f2e
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,86 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=gupnp-dlna
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../libgupnp-dlna
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=--deprecated-guards="GUPNP_DISABLE_DEPRECATED"
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/libgupnp-dlna/*.h
+CFILE_GLOB=$(top_srcdir)/libgupnp-dlna/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES= xml-util.h		\
+	       gvalue-util.h		\
+	       gupnp-dlna-load.h	\
+	       gupnp-dlna-profile.h	\
+	       gupnp-dlna-marshal.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=version.xml
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=-I$(top_srcdir) \
+	 -I$(top_srcdir)/gst-convenience/gst-libs \
+	 $(GST_CFLAGS)
+GTKDOC_LIBS=$(top_builddir)/libgupnp-dlna/libgupnp-dlna-1.0.la \
+	    $(top_builddir)/gst-convenience/gst-libs/gst/discoverer/.libs/libgstdiscoverer-gupnp-dlna-0.10.la \
+	    $(top_builddir)/gst-convenience/gst-libs/gst/profile/.libs/libgstprofile-gupnp-dlna-0.10.la
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST += version.xml.in
diff --git a/doc/gupnp-dlna-docs.sgml b/doc/gupnp-dlna-docs.sgml
new file mode 100644
index 0000000..ae550bd
--- /dev/null
+++ b/doc/gupnp-dlna-docs.sgml
@@ -0,0 +1,62 @@
+<?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>GUPnP DLNA Reference Manual</title>
+
+    <releaseinfo>Version &version;</releaseinfo>
+
+    <copyright>
+      <year>2010</year>
+      <holder>Arun Raghavan &lt;arun.raghavan@collabora.co.uk&gt;</holder>
+    </copyright>
+    <copyright>
+      <year>2010</year>
+      <holder>Collabora Multimedia</holder>
+    </copyright>
+    <copyright>
+      <year>2010</year>
+      <holder>Nokia Corporation</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>
+
+  <chapter>
+    <title>GUPnP DLNA</title>
+
+    <para>
+      GUPnP DLNA is a set of utility APIs to simplify DLNA-specific bits of
+      MediaServer implementations, such as DLNA media profile guessing.
+    </para>
+
+    <xi:include href="xml/gupnp-dlna-discoverer.xml"/>
+    <xi:include href="xml/gupnp-dlna-information.xml"/>
+
+  </chapter>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/doc/gupnp-dlna-sections.txt b/doc/gupnp-dlna-sections.txt
new file mode 100644
index 0000000..6cbadd9
--- /dev/null
+++ b/doc/gupnp-dlna-sections.txt
@@ -0,0 +1,68 @@
+<SECTION>
+<FILE>gupnp-dlna-profile</FILE>
+<TITLE>GUPnPDLNAProfile</TITLE>
+GUPnPDLNAProfile
+GUPnPDLNAProfileClass
+gupnp_dlna_profile_new
+<SUBSECTION Standard>
+GUPNP_DLNA_PROFILE
+GUPNP_IS_DLNA_PROFILE
+GUPNP_TYPE_DLNA_PROFILE
+gupnp_dlna_profile_get_type
+GUPNP_DLNA_PROFILE_CLASS
+GUPNP_IS_DLNA_PROFILE_CLASS
+GUPNP_DLNA_PROFILE_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gupnp-dlna-discoverer</FILE>
+<TITLE>GUPnPDLNADiscoverer</TITLE>
+GUPnPDLNADiscoverer
+gupnp_dlna_discoverer_new
+gupnp_dlna_discoverer_start
+gupnp_dlna_discoverer_stop
+gupnp_dlna_discoverer_discover_uri
+gupnp_dlna_discoverer_discover_uri_sync
+<SUBSECTION Standard>
+GUPnPDLNADiscovererClass
+GUPNP_DLNA_DISCOVERER
+GUPNP_IS_DLNA_DISCOVERER
+GUPNP_TYPE_DLNA_DISCOVERER
+gupnp_dlna_discoverer_get_type
+GUPNP_DLNA_DISCOVERER_CLASS
+GUPNP_IS_DLNA_DISCOVERER_CLASS
+GUPNP_DLNA_DISCOVERER_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gupnp-dlna-information</FILE>
+<TITLE>GUPnPDLNAInformation</TITLE>
+GUPnPDLNAInformation
+gupnp_dlna_information_new
+gupnp_dlna_information_get_name
+gupnp_dlna_information_get_mime
+gupnp_dlna_information_get_info
+<SUBSECTION Standard>
+GUPnPDLNAInformationClass
+GUPNP_DLNA_INFORMATION
+GUPNP_IS_DLNA_INFORMATION
+GUPNP_TYPE_DLNA_INFORMATION
+gupnp_dlna_information_get_type
+GUPNP_DLNA_INFORMATION_CLASS
+GUPNP_IS_DLNA_INFORMATION_CLASS
+GUPNP_DLNA_INFORMATION_GET_CLASS
+</SECTION>
+
+<SECTION>
+<FILE>gupnp-dlna-load</FILE>
+gupnp_dlna_load_profiles_from_file
+gupnp_dlna_load_profiles_from_dir
+gupnp_dlna_load_profiles_from_disk
+</SECTION>
+
+<SECTION>
+<FILE>gupnp-dlna-marshal</FILE>
+gupnp_dlna_marshal_BOOLEAN__STRING_UINT_STRING_POINTER
+gupnp_dlna_marshal_VOID__OBJECT_BOXED
+</SECTION>
+
diff --git a/doc/gupnp-dlna.types b/doc/gupnp-dlna.types
new file mode 100644
index 0000000..af9469a
--- /dev/null
+++ b/doc/gupnp-dlna.types
@@ -0,0 +1,3 @@
+gupnp_dlna_discoverer_get_type
+gupnp_dlna_information_get_type
+gupnp_dlna_profile_get_type
diff --git a/doc/version.xml.in b/doc/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/doc/version.xml.in
@@ -0,0 +1 @@
+@VERSION@