From: Murray Cumming Date: Fri, 12 Oct 2012 10:59:28 +0000 (+0200) Subject: docs: Add overview documentation. X-Git-Tag: RYGEL_0_17_0-w42~20 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;ds=sidebyside;h=66928dcac0fe53ed591a4b34fe6ef6009bba965d;p=profile%2Fivi%2Frygel.git docs: Add overview documentation. These mention the most interesting classes and show the example code from examples/. --- diff --git a/doc/reference/doc-build.am b/doc/reference/doc-build.am index 075196b..5221f4d 100644 --- a/doc/reference/doc-build.am +++ b/doc/reference/doc-build.am @@ -26,7 +26,9 @@ valadoc-gen: $(VALA_SOURCE_FILES_WITH_PATHS) # 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 diff --git a/doc/reference/librygel-core/gtkdoc/librygel-core-docs.xml b/doc/reference/librygel-core/gtkdoc/librygel-core-docs.xml index 361907e..b256ab5 100644 --- a/doc/reference/librygel-core/gtkdoc/librygel-core-docs.xml +++ b/doc/reference/librygel-core/gtkdoc/librygel-core-docs.xml @@ -14,9 +14,16 @@ + + + Overview + + + + librygel-core API Reference - + diff --git a/doc/reference/librygel-core/gtkdoc/overview.xml b/doc/reference/librygel-core/gtkdoc/overview.xml new file mode 100644 index 0000000..85fcb65 --- /dev/null +++ b/doc/reference/librygel-core/gtkdoc/overview.xml @@ -0,0 +1,25 @@ + + +]> + +
+ + +librygel-core is part of the Rygel project. + + + +This library allows in-process use of much of the DLNA and UPnP knowledge coded in Rygel. +It is used by the Rygel server, +librygel-renderer. +It is also used by Korva, which is in +turn used by the Helium UPnP control point. + + + +librygel-renderer-gst is licensed under the GNU Lesser General Public License (LGPL). + + +
diff --git a/doc/reference/librygel-renderer-gst/gtkdoc/librygel-renderer-gst-docs.xml b/doc/reference/librygel-renderer-gst/gtkdoc/librygel-renderer-gst-docs.xml index 7981bf3..84eb006 100644 --- a/doc/reference/librygel-renderer-gst/gtkdoc/librygel-renderer-gst-docs.xml +++ b/doc/reference/librygel-renderer-gst/gtkdoc/librygel-renderer-gst-docs.xml @@ -14,13 +14,20 @@ + + + Overview + + + + librygel-renderer-gst API Reference - + Object Hierarchy diff --git a/doc/reference/librygel-renderer-gst/gtkdoc/overview.xml b/doc/reference/librygel-renderer-gst/gtkdoc/overview.xml new file mode 100644 index 0000000..c2e05ea --- /dev/null +++ b/doc/reference/librygel-renderer-gst/gtkdoc/overview.xml @@ -0,0 +1,34 @@ + + +]> + +
+ + +librygel-renderer-gst is part of the Rygel project. + + + +This library may be used to create UPnP or DLNA Renderers using GStreamer. +The RygelPlaybinRenderer may +wrap an existing GStreamer playbin or create its own. + + + + +This example program shows how to instantiate the renderer then configure its GStreamer playbin element +and connect it to a network interface. + + + + + + +librygel-renderer-gst is licensed under the GNU Lesser General Public License (LGPL). + + +
diff --git a/doc/reference/librygel-renderer/gtkdoc/librygel-renderer-docs.xml b/doc/reference/librygel-renderer/gtkdoc/librygel-renderer-docs.xml index affaebc..408316c 100644 --- a/doc/reference/librygel-renderer/gtkdoc/librygel-renderer-docs.xml +++ b/doc/reference/librygel-renderer/gtkdoc/librygel-renderer-docs.xml @@ -14,9 +14,16 @@ + + + Overview + + + + librygel-renderer API Reference - + diff --git a/doc/reference/librygel-renderer/gtkdoc/overview.xml b/doc/reference/librygel-renderer/gtkdoc/overview.xml new file mode 100644 index 0000000..9ff83d3 --- /dev/null +++ b/doc/reference/librygel-renderer/gtkdoc/overview.xml @@ -0,0 +1,23 @@ + + +]> + +
+ + +librygel-renderer is part of the Rygel project. + + + +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. + + + +librygel-renderer-gst is licensed under the GNU Lesser General Public License (LGPL). + + +
diff --git a/doc/reference/librygel-server/gtkdoc/librygel-server-docs.xml b/doc/reference/librygel-server/gtkdoc/librygel-server-docs.xml index 933a7ae..568beaf 100644 --- a/doc/reference/librygel-server/gtkdoc/librygel-server-docs.xml +++ b/doc/reference/librygel-server/gtkdoc/librygel-server-docs.xml @@ -14,9 +14,16 @@ + + + Overview + + + + librygel-server API Reference - + diff --git a/doc/reference/librygel-server/gtkdoc/overview.xml b/doc/reference/librygel-server/gtkdoc/overview.xml new file mode 100644 index 0000000..4c6cc85 --- /dev/null +++ b/doc/reference/librygel-server/gtkdoc/overview.xml @@ -0,0 +1,33 @@ + + +]> + +
+ + +librygel-server is part of the Rygel project. + + + +This library may be used to create UPnP or DLNA servers via its +The RygelMediaServer. + + + + +This example program shows how to fill a container with media items and then instantiate a server to serve +them. + + + + + + +librygel-server is licensed under the GNU Lesser General Public License (LGPL). + + +
diff --git a/examples/standalone-renderer.c b/examples/standalone-renderer.c index 2703499..1cfc8d1 100644 --- a/examples/standalone-renderer.c +++ b/examples/standalone-renderer.c @@ -21,7 +21,7 @@ */ /* - * 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. diff --git a/src/librygel-renderer-gst/rygel-playbin-renderer.vala b/src/librygel-renderer-gst/rygel-playbin-renderer.vala index 012e11b..9438a3e 100644 --- a/src/librygel-renderer-gst/rygel-playbin-renderer.vala +++ b/src/librygel-renderer-gst/rygel-playbin-renderer.vala @@ -56,7 +56,7 @@ internal class Rygel.Playbin.WrappingPlugin : Rygel.MediaRendererPlugin { * 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 overview. */ public class Rygel.Playbin.Renderer : Rygel.MediaDevice { /** diff --git a/src/librygel-server/rygel-media-server.vala b/src/librygel-server/rygel-media-server.vala index 00e88da..afa61f3 100644 --- a/src/librygel-server/rygel-media-server.vala +++ b/src/librygel-server/rygel-media-server.vala @@ -31,7 +31,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 standalone-server.c example. + * See the example code in the overview. */ public class Rygel.MediaServer : MediaDevice {