[rygel] docs: MediaEngine: Slight improvement



commit 9be4048da63b3bd459deb00848cc57cded07978d
Author: Murray Cumming <murrayc murrayc com>
Date:   Tue Dec 4 14:55:54 2012 +0100

    docs: MediaEngine: Slight improvement

 src/librygel-server/rygel-media-engine.vala |   12 +++++++++---
 1 files changed, 9 insertions(+), 3 deletions(-)
---
diff --git a/src/librygel-server/rygel-media-engine.vala b/src/librygel-server/rygel-media-engine.vala
index 97e7746..f3e9e70 100644
--- a/src/librygel-server/rygel-media-engine.vala
+++ b/src/librygel-server/rygel-media-engine.vala
@@ -49,16 +49,22 @@ public errordomain Rygel.MediaEngineError {
 
 /**
  * This is the base class for media engines that contain knowledge about 
- * streaming and transcoding capabilites of the media library in use.
+ * the streaming and (optionally) the transcoding and seeking capabilites
+ * of the media library in use.
+ *
+ * See, for instance, Rygel's built-in "gstreamer" and "simple" media engines,
+ * or the external rygel-gst-0-10-media-engine module.
  *
- * See, for instance, Rygel's "gstreamer" and "simple" media engines.
  * The actual media engine used by Rygel at runtime is specified
- * by the media-engine configuration key/
+ * by the media-engine configuration key.
  * For instance, in rygel.conf:
  * media-engine=librygel-media-engine-gst.so
  *
  * Media engines should also derive their own Rygel.DataSource,
  * returning an instance of it from create_data_source().
+ **
+ * See the
+ * <link linkend="implementing-media-engines">Implementing Media Engines</link> section.
  */
 public abstract class Rygel.MediaEngine : GLib.Object {
     private static MediaEngine instance;



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