summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMurray Cumming <murrayc@murrayc.com>2012-11-23 13:14:49 +0100
committerMurray Cumming <murrayc@murrayc.com>2012-11-23 13:17:41 +0100
commit82a2698931bbb915e98820aaf6530d37f04e57fa (patch)
tree19e8e4d7775d342056c5c26937003a44ef86535a /doc
parent626b8e96f6482481cb01024fd8e33763443d06ff (diff)
downloadrygel-82a2698931bbb915e98820aaf6530d37f04e57fa.tar.gz
docs: librygel-renderer: Add Implementing Renderers section
However, we still need to add an example for this.
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/librygel-renderer/Makefile.am3
-rw-r--r--doc/reference/librygel-renderer/gtkdoc/implementing-renderer-plugins.xml10
-rw-r--r--doc/reference/librygel-renderer/gtkdoc/librygel-renderer-docs.xml5
3 files changed, 12 insertions, 6 deletions
diff --git a/doc/reference/librygel-renderer/Makefile.am b/doc/reference/librygel-renderer/Makefile.am
index da0f6b18..8cd4faf0 100644
--- a/doc/reference/librygel-renderer/Makefile.am
+++ b/doc/reference/librygel-renderer/Makefile.am
@@ -21,7 +21,8 @@ RYGEL_DOCBUILD_VALADOC_FLAGS = \
RYGEL_DOCBUILD_MODULE = rygel-renderer
RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS = -X -l -X $(top_builddir)/src/librygel-core/.libs/librygel-core-2.0.so
-RYGEL_GTKDOC_DOCS_XML_EXTRA = $(top_srcdir)/doc/reference/lib$(RYGEL_DOCBUILD_MODULE)/gtkdoc/implementing-renderer-plugins.xml
+RYGEL_GTKDOC_DOCS_XML_EXTRA = $(top_srcdir)/doc/reference/lib$(RYGEL_DOCBUILD_MODULE)/gtkdoc/implementing-renderer-plugins.xml \
+ $(top_srcdir)/doc/reference/lib$(RYGEL_DOCBUILD_MODULE)/gtkdoc/implementing-renderers.xml
endif
diff --git a/doc/reference/librygel-renderer/gtkdoc/implementing-renderer-plugins.xml b/doc/reference/librygel-renderer/gtkdoc/implementing-renderer-plugins.xml
index 6138b75f..574e7e61 100644
--- a/doc/reference/librygel-renderer/gtkdoc/implementing-renderer-plugins.xml
+++ b/doc/reference/librygel-renderer/gtkdoc/implementing-renderer-plugins.xml
@@ -3,7 +3,7 @@
"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'">
<!ENTITY url_git_browse_base_src "http://git.gnome.org/browse/rygel/tree/src/">
-<!ENTITY url_refdocs_librygel_renderer_gst "developer.gnome.org/librygel-renderer-gst/unstable/">
+<!ENTITY url_refdocs_librygel_renderer_gst "http:/developer.gnome.org/librygel-renderer-gst/unstable/">
]>
<section id="implementing-renderer-plugins">
@@ -17,11 +17,11 @@ implementing the <link linkend="RygelMediaRendererPlugin">RygelMediaRendererPlug
<para>
This example source code shows how to implement a Rygel Renderer plugin.</para>
-<para>This example implements a <link linkend="RygelMediaPlayer">RygelMediaPlayer</link> that simply prints the
-addresses of any URIs provided to it by a UPnP/DLNA controller. A real Rygel renderer plugin's player
-would render the actual media content to some device. See, for instance, the
+<para>This example implements module that provides a <link linkend="RygelMediaPlayer">RygelMediaPlayer</link>
+that simply prints the addresses of any URIs provided to it by a UPnP/DLNA controller. A real Rygel renderer
+plugin's player would render the actual media content to some device. See, for instance, the
<ulink url="&url_refdocs_librygel_renderer_gst;RygelPlaybinPlayer.html">RygelPlaybinPlayer</ulink> from the
-librygel-renderer-gst library.
+librygel-renderer-gst library, used in the <ulink url="&url_git_browse_base_src;plugins/playbin/">Rygel Playbin plugin</ulink>.
</para>
<!-- Do not indent the xi:include node. That puts spaces at the start of the code. -->
diff --git a/doc/reference/librygel-renderer/gtkdoc/librygel-renderer-docs.xml b/doc/reference/librygel-renderer/gtkdoc/librygel-renderer-docs.xml
index ac247116..f6ae8d32 100644
--- a/doc/reference/librygel-renderer/gtkdoc/librygel-renderer-docs.xml
+++ b/doc/reference/librygel-renderer/gtkdoc/librygel-renderer-docs.xml
@@ -21,6 +21,11 @@
</preface>
<chapter>
+ <title>Implementing Renderers</title>
+ <xi:include href="implementing-renderers.xml"/>
+ </chapter>
+
+ <chapter>
<title>Implementing Rygel Renderer Plugins</title>
<xi:include href="implementing-renderer-plugins.xml"/>
</chapter>