[rygel] docs: librygel-renderer: Add Implementing Renderers section



commit 82a2698931bbb915e98820aaf6530d37f04e57fa
Author: Murray Cumming <murrayc murrayc com>
Date:   Fri Nov 23 13:14:49 2012 +0100

    docs: librygel-renderer: Add Implementing Renderers section
    
    However, we still need to add an example for this.

 doc/reference/librygel-renderer/Makefile.am        |    3 ++-
 .../gtkdoc/implementing-renderer-plugins.xml       |   10 +++++-----
 .../gtkdoc/librygel-renderer-docs.xml              |    5 +++++
 src/librygel-renderer/rygel-media-renderer.vala    |    3 ++-
 src/librygel-server/rygel-media-server.vala        |    2 +-
 5 files changed, 15 insertions(+), 8 deletions(-)
---
diff --git a/doc/reference/librygel-renderer/Makefile.am b/doc/reference/librygel-renderer/Makefile.am
index da0f6b1..8cd4faf 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 6138b75..574e7e6 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 ac24711..f6ae8d3 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>
diff --git a/src/librygel-renderer/rygel-media-renderer.vala b/src/librygel-renderer/rygel-media-renderer.vala
index df9ce27..12e99c8 100644
--- a/src/librygel-renderer/rygel-media-renderer.vala
+++ b/src/librygel-renderer/rygel-media-renderer.vala
@@ -38,7 +38,8 @@ internal class Plugin : Rygel.MediaRendererPlugin {
  * Call rygel_media_device_add_interface() on the RygelMediaRenderer to allow it
  * to render media from that network interface.
  *
- * See the standalone-renderer.c example.
+ * See the
+ * <link linkend="implementing-renderers">Implementing Renderers</link> section.
  */
 public class Rygel.MediaRenderer : MediaDevice {
 
diff --git a/src/librygel-server/rygel-media-server.vala b/src/librygel-server/rygel-media-server.vala
index 4a1408d..abc2d7f 100644
--- a/src/librygel-server/rygel-media-server.vala
+++ b/src/librygel-server/rygel-media-server.vala
@@ -32,7 +32,7 @@ internal class Plugin : Rygel.MediaServerPlugin {
  * Call rygel_media_device_add_interface() on the RygelMediaServer to allow it
  * to serve media via that network interface.
  *
- * See the example code in the 
+ * See the
  * <link linkend="implementing-servers">Implementing Servers</link> section.
  */
 public class Rygel.MediaServer : MediaDevice {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]