diff options
| author | Murray Cumming <murrayc@openismus.com> | 2012-09-11 09:23:30 +0200 |
|---|---|---|
| committer | Murray Cumming <murrayc@murrayc.com> | 2012-09-24 12:10:22 +0200 |
| commit | 608705053440a1d89e98ab668dfa1308b664ef55 (patch) | |
| tree | 9fd27b7d55b4ae706f681931cce0e3c82a1315f5 /src | |
| parent | 1f169464c0d977225df8d25b94979a719fe5f9dc (diff) | |
| download | rygel-608705053440a1d89e98ab668dfa1308b664ef55.tar.gz | |
renderer: Document implementation classes as such.
Diffstat (limited to 'src')
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 b50e03d0..26cc0711 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 d9cc8b60..800d4fb8 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 5ddd81d1..43c069b3 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 89501570..ce556afa 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"; |