[rygel] server: docs: Mention the 3 uses.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [rygel] server: docs: Mention the 3 uses.
- Date: Tue, 16 Oct 2012 11:55:41 +0000 (UTC)
commit b5748f34b25c5fc260d4f21969e2fb2cb8b5a1c2
Author: Murray Cumming <murrayc murrayc com>
Date: Tue Oct 16 13:55:35 2012 +0200
server: docs: Mention the 3 uses.
.../gtkdoc/implementing-media-engines.xml | 14 +++++++++
.../gtkdoc/implementing-server-plugins.xml | 14 +++++++++
.../gtkdoc/implementing-servers.xml | 31 ++++++++++++++++++++
.../gtkdoc/librygel-server-docs.xml | 15 +++++++++
doc/reference/librygel-server/gtkdoc/overview.xml | 18 -----------
5 files changed, 74 insertions(+), 18 deletions(-)
---
diff --git a/doc/reference/librygel-server/gtkdoc/implementing-media-engines.xml b/doc/reference/librygel-server/gtkdoc/implementing-media-engines.xml
new file mode 100644
index 0000000..cafabb2
--- /dev/null
+++ b/doc/reference/librygel-server/gtkdoc/implementing-media-engines.xml
@@ -0,0 +1,14 @@
+<?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" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+
+<section id="implementing-media-engines">
+
+<para>
+This library may be used to create Rygel media engines by
+implementing the <link linkend="RygelMediaEngine">RygelMediaEngine</link> class.
+</para>
+
+</section>
diff --git a/doc/reference/librygel-server/gtkdoc/implementing-server-plugins.xml b/doc/reference/librygel-server/gtkdoc/implementing-server-plugins.xml
new file mode 100644
index 0000000..6597165
--- /dev/null
+++ b/doc/reference/librygel-server/gtkdoc/implementing-server-plugins.xml
@@ -0,0 +1,14 @@
+<?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" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+
+<section id="implementing-server-plugins">
+
+<para>
+This library may be used to create Rygel server plugins by
+implementing the <link linkend="RygelMediaServerPlugin">RygelMediaServerPlugin</link> class.
+</para>
+
+</section>
diff --git a/doc/reference/librygel-server/gtkdoc/implementing-servers.xml b/doc/reference/librygel-server/gtkdoc/implementing-servers.xml
new file mode 100644
index 0000000..7508f83
--- /dev/null
+++ b/doc/reference/librygel-server/gtkdoc/implementing-servers.xml
@@ -0,0 +1,31 @@
+<?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" [
+<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+
+<section id="implementing-servers">
+
+<para>
+This library may be used to create UPnP or DLNA servers via its
+The <link linkend="RygelMediaServer">RygelMediaServer</link>.
+</para>
+
+<!-- TODO: Find a way to mention this C example code in the RygelMediaServer valadoc comments instead. -->
+<para>
+This example program shows how to fill a container with media items and then instantiate a server to serve
+them.
+</para>
+
+<!-- Do not indent the xi:include node. That puts spaces at the start of the code. -->
+<programlisting role="C">
+<xi:include href="../../../../examples/standalone-server.c"
+ parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</programlisting>
+
+<para>
+librygel-server is licensed under the GNU Lesser General Public License (LGPL).
+</para>
+
+</section>
diff --git a/doc/reference/librygel-server/gtkdoc/librygel-server-docs.xml b/doc/reference/librygel-server/gtkdoc/librygel-server-docs.xml
index 568beaf..1a9ccb9 100644
--- a/doc/reference/librygel-server/gtkdoc/librygel-server-docs.xml
+++ b/doc/reference/librygel-server/gtkdoc/librygel-server-docs.xml
@@ -20,6 +20,21 @@
<xi:include href="overview.xml"/>
</preface>
+ <chapter>
+ <title>Implementing Rygel Server Plugins</title>
+ <xi:include href="implementing-server-plugins.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Implementing Rygel Media Engines</title>
+ <xi:include href="implementing-media-engines.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Implementing Servers</title>
+ <xi:include href="implementing-servers.xml"/>
+ </chapter>
+
<!-- These are generated: -->
<chapter>
<title>librygel-server API Reference</title>
diff --git a/doc/reference/librygel-server/gtkdoc/overview.xml b/doc/reference/librygel-server/gtkdoc/overview.xml
index b25a2ce..b3de263 100644
--- a/doc/reference/librygel-server/gtkdoc/overview.xml
+++ b/doc/reference/librygel-server/gtkdoc/overview.xml
@@ -11,24 +11,6 @@ librygel-server is part of the <ulink url="http://rygel-project.org/">Rygel</uli
</para>
<para>
-This library may be used to create UPnP or DLNA servers via its
-The <link linkend="RygelMediaServer">RygelMediaServer</link>.
-</para>
-
-<!-- TODO: Find a way to mention this C example code in the RygelMediaServer valadoc comments instead. -->
-<para>
-This example program shows how to fill a container with media items and then instantiate a server to serve
-them.
-</para>
-
-<!-- Do not indent the xi:include node. That puts spaces at the start of the code. -->
-<programlisting role="C">
-<xi:include href="../../../../examples/standalone-server.c"
- parse="text"
- xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</programlisting>
-
-<para>
librygel-server is licensed under the GNU Lesser General Public License (LGPL).
</para>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]