# Avoid regeneration of the html if none of its dependencies have changed:
gtkdoc/html/index.html: gtkdoc-gen
-RYGEL_GTKDOC_DOCS_XML = $(top_srcdir)/doc/reference/lib$(RYGEL_DOCBUILD_MODULE)/gtkdoc/lib$(RYGEL_DOCBUILD_MODULE)-docs.xml
+RYGEL_GTKDOC_DOCS_XML = \
+ $(top_srcdir)/doc/reference/lib$(RYGEL_DOCBUILD_MODULE)/gtkdoc/lib$(RYGEL_DOCBUILD_MODULE)-docs.xml \
+ $(top_srcdir)/doc/reference/lib$(RYGEL_DOCBUILD_MODULE)/gtkdoc/overview.xml
gtkdoc-gen: $(VALA_SOURCE_FILES_WITH_PATHS) $(RYGEL_GTKDOC_DOCS_XML)
@rm -rf gtkdoc/html
</releaseinfo>
</bookinfo>
+ <!-- This is hand written: -->
+ <preface>
+ <title>Overview</title>
+ <xi:include href="overview.xml"/>
+ </preface>
+
+ <!-- These are generated: -->
<chapter>
<title>librygel-core API Reference</title>
- <xi:include href="xml/rygel-connection-manager.xml"/>
+ <xi:include href="xml/rygel-connection-manager.xml"/>
<xi:include href="xml/rygel-configuration.xml"/>
<xi:include href="xml/rygel-log-handler.xml"/>
<xi:include href="xml/rygel-resource-info.xml"/>
--- /dev/null
+<?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="overview">
+
+<para>
+librygel-core is part of the <ulink url="http://rygel-project.org/">Rygel</ulink> project.
+</para>
+
+<para>
+This library allows in-process use of much of the DLNA and UPnP knowledge coded in Rygel.
+It is used by the <ulink url="http://rygel-project.org/">Rygel</ulink> server,
+<ulink url="http://developer.gnome.org/librygel-renderer/unstable/">librygel-renderer</ulink>.
+It is also used by <ulink url="https://live.gnome.org/Rygel/Korva">Korva</ulink>, which is in
+turn used by the <ulink href="http://jensge.org/helium-a-m-dmc-for-your-n9/">Helium</ulink> UPnP control point.
+</para>
+
+<para>
+librygel-renderer-gst is licensed under the GNU Lesser General Public License (LGPL).
+</para>
+
+</section>
</releaseinfo>
</bookinfo>
+ <!-- This is hand written: -->
+ <preface>
+ <title>Overview</title>
+ <xi:include href="overview.xml"/>
+ </preface>
+
+ <!-- These are generated: -->
<chapter>
<title>librygel-renderer-gst API Reference</title>
<xi:include href="xml/rygel-playbin-renderer.xml"/>
<xi:include href="xml/rygel-playbin-player.xml"/>
<xi:include href="xml/rygel-playbin-plugin.xml"/>
-
</chapter>
+
<chapter id="object-tree">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
--- /dev/null
+<?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="overview">
+
+<para>
+librygel-renderer-gst is part of the <ulink url="http://rygel-project.org/">Rygel</ulink> project.
+</para>
+
+<para>
+This library may be used to create UPnP or DLNA Renderers using GStreamer.
+The <link linkend="RygelPlaybinRenderer">RygelPlaybinRenderer</link> may
+wrap an existing GStreamer playbin or create its own.
+</para>
+
+<!-- TODO: Find a way to mention this C example code in the RygelPlaybinRenderer valadoc comments instead. -->
+<para>
+This example program shows how to instantiate the renderer then configure its GStreamer playbin element
+and connect it to a network interface.
+</para>
+<programlisting role="C">
+ <xi:include href="../../../../examples/standalone-renderer.c"
+ parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</programlisting>
+
+<para>
+librygel-renderer-gst is licensed under the GNU Lesser General Public License (LGPL).
+</para>
+
+</section>
</releaseinfo>
</bookinfo>
+ <!-- This is hand written: -->
+ <preface>
+ <title>Overview</title>
+ <xi:include href="overview.xml"/>
+ </preface>
+
+ <!-- These are generated: -->
<chapter>
<title>librygel-renderer API Reference</title>
- <xi:include href="xml/rygel-media-renderer-plugin.xml"/>
+ <xi:include href="xml/rygel-media-renderer-plugin.xml"/>
<xi:include href="xml/rygel-media-renderer.xml"/>
<xi:include href="xml/rygel-media-player.xml"/>
--- /dev/null
+<?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="overview">
+
+<para>
+librygel-renderer is part of the <ulink url="http://rygel-project.org/">Rygel</ulink> project.
+</para>
+
+<para>
+This library may be used to create UPnP or DLNA Renderers.
+For instance, librygel-renderer-gst uses librygel-renderer with GStreamer
+to implement its RygelPlaybinRenderer renderer.
+</para>
+
+<para>
+librygel-renderer-gst is licensed under the GNU Lesser General Public License (LGPL).
+</para>
+
+</section>
</releaseinfo>
</bookinfo>
+ <!-- This is hand written: -->
+ <preface>
+ <title>Overview</title>
+ <xi:include href="overview.xml"/>
+ </preface>
+
+ <!-- These are generated: -->
<chapter>
<title>librygel-server API Reference</title>
- <xi:include href="xml/rygel-image-item.xml"/>
+ <xi:include href="xml/rygel-image-item.xml"/>
<xi:include href="xml/rygel-photo-item.xml"/>
<xi:include href="xml/rygel-media-item.xml"/>
<xi:include href="xml/rygel-data-source.xml"/>
--- /dev/null
+<?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="overview">
+
+<para>
+librygel-server is part of the <ulink url="http://rygel-project.org/">Rygel</ulink> project.
+</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>
+<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>
*/
/*
- * Demo application for librygel-renderer.
+ * Demo application for librygel-renderer-gst.
*
* Creates a simple stand-alone UPnP renderer that renders any visual content
* in ASCII-art using GStreamer's cacasink element.
* to be controlled by a control point and to retrieve data streams via that
* network interface.
*
- * See the standalone-renderer.c example.
+ * See the example code in the <link linkend="overview">overview</link>.
*/
public class Rygel.Playbin.Renderer : Rygel.MediaDevice {
/**
* Call rygel_media_device_add_interface() on the RygelMediaServer to allow it
* to serve media via that network interface.
*
- * See the standalone-server.c example.
+ * See the example code in the <link linkend="overview">overview</link>.
*/
public class Rygel.MediaServer : MediaDevice {