[libdmapsharing] Add documentation overview.

[W. Michael Petullo <wmpetullo src gnome org>]

commit 8a3140e50bed12ba95f789222a1c983812943fcd
Author: W. Michael Petullo <mike flyn org>
Date:   Fri Aug 14 16:33:53 2009 -0400

    Add documentation overview.
    
    Added an overview of the libdmapsharing API to the gtk-doc documentation.

 docs/containerdb.sgml         |   28 ++++++++++++++++++++++++++
 docs/libdmapsharing-docs.sgml |   44 +++++++++++++++++++++++++++++++++++++++++
 docs/mediadb.sgml             |   30 +++++++++++++++++++++++++++
 docs/shareapi.sgml            |   33 ++++++++++++++++++++++++++++++
 4 files changed, 135 insertions(+), 0 deletions(-)
---
diff --git a/docs/containerdb.sgml b/docs/containerdb.sgml
new file mode 100644
index 0000000..017d8e8
--- /dev/null
+++ b/docs/containerdb.sgml
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"; [
+]>
+<refentry id="containerdb">
+	<refmeta>
+		<refentrytitle>Container Database Implementation</refentrytitle>
+		<manvolnum>3</manvolnum>
+		<refmiscinfo>Libdmapsharing</refmiscinfo>
+	</refmeta>
+
+	<refnamediv>
+		<refname>Container Database Implementation</refname>
+		<refpurpose>
+			Implementing a container database
+		</refpurpose>
+	</refnamediv>
+
+	<refsect1>
+		<title>Container Database Implementation</title>
+		<para>
+Second, define classes that implement the DMAPContainerDb and
+DMAPContainerRecord interfaces (see test-dmap-container-db.c and
+test-dmap-container-record.c). These classes will allow the creation of
+playlists (DAAP) or albums (DPAP).
+		</para>
+	</refsect1>
+</refentry>
diff --git a/docs/libdmapsharing-docs.sgml b/docs/libdmapsharing-docs.sgml
new file mode 100644
index 0000000..6dfe5e4
--- /dev/null
+++ b/docs/libdmapsharing-docs.sgml
@@ -0,0 +1,44 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index">
+  <bookinfo>
+    <title>libdmapsharing Reference Manual</title>
+    <releaseinfo>
+      for libdmapsharing [VERSION]
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/libdmapsharing/index.html";>http://[SERVER]/libdmapsharing/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>[Insert title here]</title>
+        <xi:include href="xml/dmap-container-db.xml"/>
+    <xi:include href="xml/dmap-share.xml"/>
+    <xi:include href="xml/dpap-share.xml"/>
+    <xi:include href="xml/dmap-container-record.xml"/>
+    <xi:include href="xml/daap-share.xml"/>
+    <xi:include href="xml/daap-record.xml"/>
+    <xi:include href="xml/daap-connection.xml"/>
+    <xi:include href="xml/dmap-record.xml"/>
+    <xi:include href="xml/dpap-record.xml"/>
+    <xi:include href="xml/dmap-record-factory.xml"/>
+    <xi:include href="xml/dpap-connection.xml"/>
+    <xi:include href="xml/dmap-connection.xml"/>
+    <xi:include href="xml/dmap-db.xml"/>
+
+  </chapter>
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+     <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/docs/mediadb.sgml b/docs/mediadb.sgml
new file mode 100644
index 0000000..49b465b
--- /dev/null
+++ b/docs/mediadb.sgml
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"; [
+]>
+<refentry id="mediadb">
+	<refmeta>
+		<refentrytitle>Media Database Implementation</refentrytitle>
+		<manvolnum>3</manvolnum>
+		<refmiscinfo>Libdmapsharing</refmiscinfo>
+	</refmeta>
+
+	<refnamediv>
+		<refname>Media Database Implementation</refname>
+		<refpurpose>
+			Implementing a media database
+		</refpurpose>
+	</refnamediv>
+
+	<refsect1>
+		<title>Media Database Implementation</title>
+		<para>
+First, define classes that implement the DAAPDb (or DPAP) and DAAPRecord
+interfaces (for an example, see test-daap-db.c and test-daap-record.c). If
+your application already has a media database interface, then these new
+definitions will simply be adapter classes encapsulating your existing
+interface.
+
+		</para>
+	</refsect1>
+</refentry>
diff --git a/docs/shareapi.sgml b/docs/shareapi.sgml
new file mode 100644
index 0000000..1d487c5
--- /dev/null
+++ b/docs/shareapi.sgml
@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"; [
+]>
+<refentry id="shareapi">
+	<refmeta>
+		<refentrytitle>Share API</refentrytitle>
+		<manvolnum>3</manvolnum>
+		<refmiscinfo>Libdmapsharing</refmiscinfo>
+	</refmeta>
+
+	<refnamediv>
+		<refname>Share API</refname>
+		<refpurpose>
+			Using the share API
+		</refpurpose>
+	</refnamediv>
+
+	<refsect1>
+		<title>Share API</title>
+		<para>
+Finally, write the code that creates a new DAAPShare object (see
+test-dmap-server.c) and provide it your DAAPDb object.
+
+		</para>
+
+		<para>
+The libdmapsharing package also provides an optional interface,
+DMAPRecordFactory, that may be convenient for application developers.
+
+		</para>
+	</refsect1>
+</refentry>