[rygel] renderer: Document implementation classes as such.



commit 608705053440a1d89e98ab668dfa1308b664ef55
Author: Murray Cumming <murrayc openismus com>
Date:   Tue Sep 11 09:23:30 2012 +0200

    renderer: Document implementation classes as such.

 src/librygel-renderer/rygel-media-player.vala      |    2 ++
 .../rygel-media-renderer-plugin.vala               |    2 ++
 src/librygel-renderer/rygel-playbin-player.vala    |    2 ++
 src/librygel-renderer/rygel-playbin-plugin.vala    |    2 ++
 4 files changed, 8 insertions(+), 0 deletions(-)
---
diff --git a/src/librygel-renderer/rygel-media-player.vala b/src/librygel-renderer/rygel-media-player.vala
index b50e03d..26cc071 100644
--- a/src/librygel-renderer/rygel-media-player.vala
+++ b/src/librygel-renderer/rygel-media-player.vala
@@ -26,6 +26,8 @@ using Gst;
 
 /**
  * Interface for mapping AVTransport:2 methods to the specific implementation.
+ *
+ * This class is useful only when implementing Rygel plugins.
  */
 public interface Rygel.MediaPlayer : GLib.Object {
     public abstract string playback_state { owned get; set; }
diff --git a/src/librygel-renderer/rygel-media-renderer-plugin.vala b/src/librygel-renderer/rygel-media-renderer-plugin.vala
index d9cc8b6..800d4fb 100644
--- a/src/librygel-renderer/rygel-media-renderer-plugin.vala
+++ b/src/librygel-renderer/rygel-media-renderer-plugin.vala
@@ -24,6 +24,8 @@
 
 /**
  * Base class for every Rygel UPnP renderer plugin.
+ *
+ * This class is useful only when implementing Rygel plugins.
  */
 public class Rygel.MediaRendererPlugin : Rygel.Plugin {
     private static const string MEDIA_RENDERER_DESC_PATH =
diff --git a/src/librygel-renderer/rygel-playbin-player.vala b/src/librygel-renderer/rygel-playbin-player.vala
index 5ddd81d..43c069b 100644
--- a/src/librygel-renderer/rygel-playbin-player.vala
+++ b/src/librygel-renderer/rygel-playbin-player.vala
@@ -29,6 +29,8 @@ using GUPnP;
 
 /**
  * Implementation of RygelMediaPlayer for GStreamer.
+ *
+ * This class is useful only when implementing Rygel plugins.
  */
 public class Rygel.Playbin.Player : GLib.Object, Rygel.MediaPlayer {
     private const string TRANSFER_MODE_STREAMING = "Streaming";
diff --git a/src/librygel-renderer/rygel-playbin-plugin.vala b/src/librygel-renderer/rygel-playbin-plugin.vala
index 8950157..ce556af 100644
--- a/src/librygel-renderer/rygel-playbin-plugin.vala
+++ b/src/librygel-renderer/rygel-playbin-plugin.vala
@@ -30,6 +30,8 @@ using Gee;
 
 /**
  * Implementation of RygelMediaRendererPlugin for GStreamer.
+ *
+ * This class is useful only when implementing Rygel plugins.
  */
 public class Rygel.Playbin.Plugin : Rygel.MediaRendererPlugin {
     public const string NAME = "Playbin";



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