[Xfce4-commits] [apps/parole] 01/01: gtk-doc: Add missing value descriptions
noreply at xfce.org
noreply at xfce.org
Sun May 28 02:33:07 CEST 2017
This is an automated email from the git hooks/post-receive script.
b l u e s a b r e p u s h e d a c o m m i t t o b r a n c h m a s t e r
in repository apps/parole.
commit 071d8ed0e818a3c343520890099de11cb8c3819c
Author: Sean Davis <smd.seandavis at gmail.com>
Date: Sat May 27 20:33:01 2017 -0400
gtk-doc: Add missing value descriptions
---
docs/plugin-api/tmpl/parole-provider-player.sgml | 2 --
src/misc/parole-pl-parser.h | 11 ++++++++++
src/misc/parole-provider-player.h | 8 ++++++++
src/misc/parole-stream.h | 26 +++++++++++++++++++++++-
4 files changed, 44 insertions(+), 3 deletions(-)
diff --git a/docs/plugin-api/tmpl/parole-provider-player.sgml b/docs/plugin-api/tmpl/parole-provider-player.sgml
index 56dd67e..fa129b5 100644
--- a/docs/plugin-api/tmpl/parole-provider-player.sgml
+++ b/docs/plugin-api/tmpl/parole-provider-player.sgml
@@ -225,5 +225,3 @@ playback status.
</para>
@player:
-
-
diff --git a/src/misc/parole-pl-parser.h b/src/misc/parole-pl-parser.h
index ca65e37..ef56e31 100644
--- a/src/misc/parole-pl-parser.h
+++ b/src/misc/parole-pl-parser.h
@@ -31,6 +31,17 @@
G_BEGIN_DECLS
+/**
+ * ParolePlFormat:
+ * @PAROLE_PL_FORMAT_UNKNOWN: Unknown format
+ * @PAROLE_PL_FORMAT_M3U: M3U format
+ * @PAROLE_PL_FORMAT_PLS: PLS format
+ * @PAROLE_PL_FORMAT_ASX: ASX format
+ * @PAROLE_PL_FORMAT_XSPF: XSPF format
+ *
+ * Parole Playlist Formats.
+ *
+ **/
typedef enum
{
PAROLE_PL_FORMAT_UNKNOWN,
diff --git a/src/misc/parole-provider-player.h b/src/misc/parole-provider-player.h
index 6f15539..fabd1e7 100644
--- a/src/misc/parole-provider-player.h
+++ b/src/misc/parole-provider-player.h
@@ -41,6 +41,14 @@ G_BEGIN_DECLS
typedef struct _ParoleProviderPlayerIface ParoleProviderPlayerIface;
typedef struct _ParoleProviderPlayer ParoleProviderPlayer;
+/**
+ * ParolePluginContainer:
+ * @PAROLE_PLUGIN_CONTAINER_PLAYLIST: Playlist container
+ * @PAROLE_PLUGIN_CONTAINER_MAIN_VIEW: Main view container
+ *
+ * Available plugin widget containers.
+ *
+ **/
typedef enum
{
PAROLE_PLUGIN_CONTAINER_PLAYLIST,
diff --git a/src/misc/parole-stream.h b/src/misc/parole-stream.h
index e5b85cf..6c7d748 100644
--- a/src/misc/parole-stream.h
+++ b/src/misc/parole-stream.h
@@ -36,6 +36,20 @@ G_BEGIN_DECLS
#define PAROLE_STREAM(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), PAROLE_TYPE_STREAM, ParoleStream))
#define PAROLE_IS_STREAM(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), PAROLE_TYPE_STREAM))
+/**
+ * ParoleMediaType:
+ * @PAROLE_MEDIA_TYPE_UNKNOWN: Unknown media type
+ * @PAROLE_MEDIA_TYPE_LOCAL_FILE: File found on hard disk
+ * @PAROLE_MEDIA_TYPE_CDDA: Audio CD
+ * @PAROLE_MEDIA_TYPE_VCD: Video CD
+ * @PAROLE_MEDIA_TYPE_SVCD: Super Video CD
+ * @PAROLE_MEDIA_TYPE_DVD: DVD
+ * @PAROLE_MEDIA_TYPE_DVB: Digital Video Broadcast
+ * @PAROLE_MEDIA_TYPE_REMOTE: File stored remotely
+ *
+ * Media types.
+ *
+ **/
typedef enum
{
PAROLE_MEDIA_TYPE_UNKNOWN,
@@ -49,7 +63,17 @@ typedef enum
} ParoleMediaType;
-
+/**
+ * ParoleState:
+ * @PAROLE_STATE_STOPPED: Playback is stopped
+ * @PAROLE_STATE_PLAYBACK_FINISHED: Playback has finished
+ * @PAROLE_STATE_ABOUT_TO_FINISH: Playback is about to finish
+ * @PAROLE_STATE_PAUSED: Playback is paused
+ * @PAROLE_STATE_PLAYING: Playback is active
+ *
+ * Media playback states.
+ *
+ **/
typedef enum
{
PAROLE_STATE_STOPPED = 0,
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the Xfce4-commits
mailing list