[Xfce4-commits] [apps/parole] 01/01: Complete the Parole Plugins documentation. 100% symbol docs coverage. 132 symbols documented. 0 symbols incomplete. 0 not documented.
noreply at xfce.org
noreply at xfce.org
Fri Jun 2 05:01:20 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 33bcaf34f24384cf365cbfb276041fc5183f8ba1
Author: Sean Davis <smd.seandavis at gmail.com>
Date: Thu Jun 1 23:00:42 2017 -0400
Complete the Parole Plugins documentation.
100% symbol docs coverage.
132 symbols documented.
0 symbols incomplete.
0 not documented.
---
docs/plugin-api/Makefile.am | 1 -
docs/plugin-api/Parole-Plugins-sections.txt | 13 ----
docs/plugin-api/Parole-Plugins.types | 4 --
docs/plugin-api/tmpl/Parole-Plugins-unused.sgml | 1 -
docs/plugin-api/tmpl/parole-debug.sgml | 6 +-
docs/plugin-api/tmpl/parole-enum-types.sgml | 86 ------------------------
docs/plugin-api/tmpl/parole-file.sgml | 6 +-
docs/plugin-api/tmpl/parole-filters.sgml | 6 +-
docs/plugin-api/tmpl/parole-marshal.sgml | 50 +++++++-------
docs/plugin-api/tmpl/parole-pl-parser.sgml | 6 +-
docs/plugin-api/tmpl/parole-provider-player.sgml | 21 ++++++
docs/plugin-api/tmpl/parole-stream.sgml | 3 +-
docs/plugin-api/tmpl/parole.sgml | 6 +-
docs/plugin-api/tmpl/stamp-enum-types.sgml | 6 +-
src/misc/Makefile.am | 2 +-
src/misc/parole-debug.c | 29 +++++++-
src/misc/parole-debug.h | 18 +++++
src/misc/parole-file.c | 32 ++++++++-
src/misc/parole-file.h | 7 ++
src/misc/parole-filters.c | 22 +++++-
src/misc/parole-pl-parser.c | 1 +
src/misc/parole-provider-player.c | 1 -
src/misc/parole-provider-player.h | 17 +++++
src/misc/parole-provider-plugin.h | 19 ++++++
src/misc/parole-stream.c | 10 +++
src/misc/parole-stream.h | 11 ++-
src/misc/parole.h.in | 36 ++++++++++
src/parole-utils.c | 4 +-
28 files changed, 256 insertions(+), 168 deletions(-)
diff --git a/docs/plugin-api/Makefile.am b/docs/plugin-api/Makefile.am
index 731b054..51f13d2 100644
--- a/docs/plugin-api/Makefile.am
+++ b/docs/plugin-api/Makefile.am
@@ -92,4 +92,3 @@ EXTRA_DIST += \
version.xml.in \
$(DOC_MAIN_SGML_FILE) \
parole-plugins-tut.sgml
-
diff --git a/docs/plugin-api/Parole-Plugins-sections.txt b/docs/plugin-api/Parole-Plugins-sections.txt
index 9f4ee8e..e5986c2 100644
--- a/docs/plugin-api/Parole-Plugins-sections.txt
+++ b/docs/plugin-api/Parole-Plugins-sections.txt
@@ -86,18 +86,6 @@ parole_stream_init_properties
</SECTION>
<SECTION>
-<FILE>parole-enum-types</FILE>
-parole_media_type_get_type
-PAROLE_ENUM_TYPE_MEDIA_TYPE
-parole_plugin_container_get_type
-PAROLE_ENUM_TYPE_PLUGIN_CONTAINER
-parole_state_get_type
-PAROLE_ENUM_TYPE_STATE
-parole_pl_format_get_type
-PAROLE_ENUM_TYPE_PL_FORMAT
-</SECTION>
-
-<SECTION>
<FILE>parole-pl-parser</FILE>
ParolePlFormat
parole_pl_parser_guess_format_from_extension
@@ -152,4 +140,3 @@ PAROLE_DEBUG_ENUM_FULL
parole_debug_enum
parole_debug_enum_full
</SECTION>
-
diff --git a/docs/plugin-api/Parole-Plugins.types b/docs/plugin-api/Parole-Plugins.types
index b953d66..ca28fe1 100644
--- a/docs/plugin-api/Parole-Plugins.types
+++ b/docs/plugin-api/Parole-Plugins.types
@@ -1,8 +1,4 @@
parole_file_get_type
-parole_media_type_get_type
-parole_pl_format_get_type
-parole_plugin_container_get_type
parole_provider_player_get_type
parole_provider_plugin_get_type
-parole_state_get_type
parole_stream_get_type
diff --git a/docs/plugin-api/tmpl/Parole-Plugins-unused.sgml b/docs/plugin-api/tmpl/Parole-Plugins-unused.sgml
index 42bdc7a..301bcd5 100644
--- a/docs/plugin-api/tmpl/Parole-Plugins-unused.sgml
+++ b/docs/plugin-api/tmpl/Parole-Plugins-unused.sgml
@@ -21,4 +21,3 @@
</para>
@parent_class:
-
diff --git a/docs/plugin-api/tmpl/parole-debug.sgml b/docs/plugin-api/tmpl/parole-debug.sgml
index 4de4b54..39ed928 100644
--- a/docs/plugin-api/tmpl/parole-debug.sgml
+++ b/docs/plugin-api/tmpl/parole-debug.sgml
@@ -2,11 +2,11 @@
Parole Debug
<!-- ##### SECTION Short_Description ##### -->
-
+Convenience functions for simple debugging
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+Functionality provided by ParoleDebug simplifies debugging of complex data types.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -65,5 +65,3 @@ Parole Debug
@type:
@format:
@...:
-
-
diff --git a/docs/plugin-api/tmpl/parole-enum-types.sgml b/docs/plugin-api/tmpl/parole-enum-types.sgml
deleted file mode 100644
index e714eaa..0000000
--- a/docs/plugin-api/tmpl/parole-enum-types.sgml
+++ /dev/null
@@ -1,86 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-parole-enum-types
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### FUNCTION parole_media_type_get_type ##### -->
-<para>
-
-</para>
-
- at void:
- at Returns:
-
-
-<!-- ##### MACRO PAROLE_ENUM_TYPE_MEDIA_TYPE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION parole_plugin_container_get_type ##### -->
-<para>
-
-</para>
-
- at void:
- at Returns:
-
-
-<!-- ##### MACRO PAROLE_ENUM_TYPE_PLUGIN_CONTAINER ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION parole_state_get_type ##### -->
-<para>
-
-</para>
-
- at void:
- at Returns:
-
-
-<!-- ##### MACRO PAROLE_ENUM_TYPE_STATE ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### FUNCTION parole_pl_format_get_type ##### -->
-<para>
-
-</para>
-
- at void:
- at Returns:
-
-
-<!-- ##### MACRO PAROLE_ENUM_TYPE_PL_FORMAT ##### -->
-<para>
-
-</para>
-
-
-
diff --git a/docs/plugin-api/tmpl/parole-file.sgml b/docs/plugin-api/tmpl/parole-file.sgml
index c2aeb31..8573933 100644
--- a/docs/plugin-api/tmpl/parole-file.sgml
+++ b/docs/plugin-api/tmpl/parole-file.sgml
@@ -2,11 +2,11 @@
ParoleFile
<!-- ##### SECTION Short_Description ##### -->
-Simple file handling.
+Simple file handling
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+ParoleFile provides an easy interface for manipulating chapters and tracks.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -179,5 +179,3 @@ Simple file handling.
@file:
@Returns:
-
-
diff --git a/docs/plugin-api/tmpl/parole-filters.sgml b/docs/plugin-api/tmpl/parole-filters.sgml
index 41c0d00..edbd34f 100644
--- a/docs/plugin-api/tmpl/parole-filters.sgml
+++ b/docs/plugin-api/tmpl/parole-filters.sgml
@@ -2,11 +2,11 @@
Parole Filters
<!-- ##### SECTION Short_Description ##### -->
-
+File filtering for Parole's supported media types
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+ParoleFilters simplifies file browsing by restricting views to only those files supported by Parole.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -73,5 +73,3 @@ Parole Filters
@filter:
@file:
@Returns:
-
-
diff --git a/docs/plugin-api/tmpl/parole-marshal.sgml b/docs/plugin-api/tmpl/parole-marshal.sgml
index 96bd431..8acb556 100644
--- a/docs/plugin-api/tmpl/parole-marshal.sgml
+++ b/docs/plugin-api/tmpl/parole-marshal.sgml
@@ -1,12 +1,12 @@
<!-- ##### SECTION Title ##### -->
-parole-marshal
+Parole Marshal
<!-- ##### SECTION Short_Description ##### -->
-
+Marshal functions for Parole
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+Marshal functions for Parole
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -22,40 +22,38 @@ parole-marshal
<!-- ##### FUNCTION parole_marshal_VOID__OBJECT_ENUM ##### -->
<para>
-
+VOID:OBJECT,ENUM
</para>
- at closure:
- at return_value:
- at n_param_values:
- at param_values:
- at invocation_hint:
- at marshal_data:
+ at closure: closure
+ at return_value: return value
+ at n_param_values: number of parameter values
+ at param_values: parameter values
+ at invocation_hint: invocation hint
+ at marshal_data: marshal data
<!-- ##### FUNCTION parole_marshal_VOID__OBJECT_DOUBLE ##### -->
<para>
-
+VOID:OBJECT,DOUBLE
</para>
- at closure:
- at return_value:
- at n_param_values:
- at param_values:
- at invocation_hint:
- at marshal_data:
+ at closure: closure
+ at return_value: return value
+ at n_param_values: number of parameter values
+ at param_values: parameter values
+ at invocation_hint: invocation hint
+ at marshal_data: marshal data
<!-- ##### FUNCTION parole_marshal_VOID__OBJECT_INT ##### -->
<para>
-
+VOID:OBJECT,INT
</para>
- at closure:
- at return_value:
- at n_param_values:
- at param_values:
- at invocation_hint:
- at marshal_data:
-
-
+ at closure: closure
+ at return_value: return value
+ at n_param_values: number of parameter values
+ at param_values: parameter values
+ at invocation_hint: invocation hint
+ at marshal_data: marshal data
diff --git a/docs/plugin-api/tmpl/parole-pl-parser.sgml b/docs/plugin-api/tmpl/parole-pl-parser.sgml
index 8f345a2..0d87800 100644
--- a/docs/plugin-api/tmpl/parole-pl-parser.sgml
+++ b/docs/plugin-api/tmpl/parole-pl-parser.sgml
@@ -2,11 +2,11 @@
Parole Playlist Parser
<!-- ##### SECTION Short_Description ##### -->
-
+Advanced playlist support
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+Parole's playlist parser allows for reading and writing standard playlist files.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -86,5 +86,3 @@ Parole Playlist Parser
@filename:
@format:
@Returns:
-
-
diff --git a/docs/plugin-api/tmpl/parole-provider-player.sgml b/docs/plugin-api/tmpl/parole-provider-player.sgml
index fa129b5..73c3006 100644
--- a/docs/plugin-api/tmpl/parole-provider-player.sgml
+++ b/docs/plugin-api/tmpl/parole-provider-player.sgml
@@ -78,6 +78,18 @@ playback status.
@PAROLE_STATE_PAUSED:
@PAROLE_STATE_PLAYING:
+
+
+<!-- ##### FUNCTION parole_provider_player_get_main_window ##### -->
+<para>
+
+</para>
+
+ at player:
+ at Returns:
+
+
+
<!-- ##### FUNCTION parole_provider_player_pack ##### -->
<para>
@@ -145,6 +157,15 @@ playback status.
@Returns:
+<!-- ##### FUNCTION parole_provider_player_get_stream ##### -->
+<para>
+
+</para>
+
+ at player:
+ at Returns:
+
+
<!-- ##### FUNCTION parole_provider_player_get_stream_position ##### -->
<para>
diff --git a/docs/plugin-api/tmpl/parole-stream.sgml b/docs/plugin-api/tmpl/parole-stream.sgml
index 6de4b90..0ac63f5 100644
--- a/docs/plugin-api/tmpl/parole-stream.sgml
+++ b/docs/plugin-api/tmpl/parole-stream.sgml
@@ -8,7 +8,7 @@ Currently playing stream.
<para>
This object contains all the information describing the current processed stream
by Parole, this object is used with the callback function the #ParoleProviderPlayerIface::state-changed
-signal of the player, the plugin shouldn't take reference and all the properties are read-only for the plugins.s
+signal of the player, the plugin shouldn't take reference and all the properties are read-only for the plugins.
</para>
@@ -162,4 +162,3 @@ signal of the player, the plugin shouldn't take reference and all the properties
<para>
</para>
-
diff --git a/docs/plugin-api/tmpl/parole.sgml b/docs/plugin-api/tmpl/parole.sgml
index 0512f9f..7005ccd 100644
--- a/docs/plugin-api/tmpl/parole.sgml
+++ b/docs/plugin-api/tmpl/parole.sgml
@@ -2,11 +2,11 @@
Parole
<!-- ##### SECTION Short_Description ##### -->
-
+Parole Media Player
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+A powerful media player for the Xfce desktop environment.
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -130,5 +130,3 @@ Parole
@void:
@Returns:
-
-
diff --git a/docs/plugin-api/tmpl/stamp-enum-types.sgml b/docs/plugin-api/tmpl/stamp-enum-types.sgml
index 515350f..b5034d6 100644
--- a/docs/plugin-api/tmpl/stamp-enum-types.sgml
+++ b/docs/plugin-api/tmpl/stamp-enum-types.sgml
@@ -2,11 +2,11 @@
stamp-enum-types
<!-- ##### SECTION Short_Description ##### -->
-
+Enumeration types timestamp
<!-- ##### SECTION Long_Description ##### -->
<para>
-
+Enumeration types timestamp
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -18,5 +18,3 @@ stamp-enum-types
<!-- ##### SECTION Image ##### -->
-
-
diff --git a/src/misc/Makefile.am b/src/misc/Makefile.am
index 76c1865..0a8eda3 100644
--- a/src/misc/Makefile.am
+++ b/src/misc/Makefile.am
@@ -76,7 +76,7 @@ stamp-enum-types.h: $(parole_glib_enum_headers) Makefile
( cd $(srcdir) && glib-mkenums \
--fhead "#ifndef SRC_MISC_PAROLE_ENUM_TYPES_H_\n#define SRC_MISC_PAROLE_ENUM_TYPES_H_\n#include <glib-object.h>\nG_BEGIN_DECLS\n" \
--fprod "/* enumerations from \"@filename@\" */\n" \
- --vhead "GType @enum_name at _get_type (void);\n#define PAROLE_ENUM_TYPE_ at ENUMSHORT@ (@enum_name at _get_type())\n" \
+ --vhead "#ifndef __GTK_DOC_IGNORE__\nGType @enum_name at _get_type (void);\n#define PAROLE_ENUM_TYPE_ at ENUMSHORT@ (@enum_name at _get_type())\n#endif\n" \
--ftail "G_END_DECLS\n\n#endif /* SRC_MISC_PAROLE_ENUM_TYPES_H_ */" \
$(parole_glib_enum_headers) ) > xgen-enum.h \
&& (cmp -s xgen-enum.h parole-enum-types.h || cp xgen-enum.h parole-enum-types.h) \
diff --git a/src/misc/parole-debug.c b/src/misc/parole-debug.c
index 2f2858d..623fb22 100644
--- a/src/misc/parole-debug.c
+++ b/src/misc/parole-debug.c
@@ -36,8 +36,20 @@
#if defined(DEBUG) && defined(G_HAVE_ISO_VARARGS)
+/**
+ * parole_debug_enum:
+ * @func: calling function
+ * @file: calling file
+ * @line: calling line
+ * @text: text to display
+ * @v_enum: enum to evaluate
+ * @type: enum type
+ *
+ * A function to print debug information for an enum.
+ *
+ **/
void parole_debug_enum(const gchar *func, const gchar *file, gint line,
- const gchar *text, gint v_enum, GType type) {
+ const gchar *text, gint v_enum, GType type) {
gchar *content = NULL;
GValue __value__ = { 0, };
@@ -53,8 +65,21 @@ void parole_debug_enum(const gchar *func, const gchar *file, gint line,
g_free(content);
}
+/**
+ * parole_debug_enum_full:
+ * @func: calling function
+ * @file: calling file
+ * @line: calling line
+ * @v_enum: enum to evaluate
+ * @type: enum type
+ * @format: format string, followed by parameters to insert into the format string (as with printf())
+ * @...: parameters to insert into the format string
+ *
+ * A function to print debug information with extended content for an enum.
+ *
+ **/
void parole_debug_enum_full(const gchar *func, const gchar *file, gint line,
- gint v_enum, GType type, const gchar *format, ...) {
+ gint v_enum, GType type, const gchar *format, ...) {
va_list args;
gchar *buffer;
diff --git a/src/misc/parole-debug.h b/src/misc/parole-debug.h
index c8d9838..ef597e1 100644
--- a/src/misc/parole-debug.h
+++ b/src/misc/parole-debug.h
@@ -34,9 +34,27 @@ G_BEGIN_DECLS
#if defined(DEBUG) && defined(G_HAVE_ISO_VARARGS)
+/**
+ * PAROLE_DEBUG_ENUM:
+ * @_text: text to display
+ * @_value: enum to evaluate
+ * @_type: enum type
+ *
+ * A macro to print debug information for an enum.
+ *
+ */
#define PAROLE_DEBUG_ENUM(_text, _value, _type)\
parole_debug_enum (__func__, __FILE__, __LINE__, _text, _value, _type)
+/**
+ * PAROLE_DEBUG_ENUM_FULL:
+ * @_value: enum to evaluate
+ * @_type: enum type
+ * @...: format string, followed by parameters to insert into the format string (as with printf())
+ *
+ * A macro to print debug information with extended content for an enum.
+ *
+ */
#define PAROLE_DEBUG_ENUM_FULL(_value, _type, ...)\
parole_debug_enum_full (__func__, __FILE__, __LINE__, _value, _type, __VA_ARGS__)
diff --git a/src/misc/parole-file.c b/src/misc/parole-file.c
index e6accee..e32205d 100644
--- a/src/misc/parole-file.c
+++ b/src/misc/parole-file.c
@@ -395,7 +395,7 @@ parole_file_init(ParoleFile *file) {
* parole_file_new:
* @filename: filename.
*
- *
+ * Create a new #ParoleFile
*
* Returns: A new #ParoleFile object.
*
@@ -411,8 +411,9 @@ parole_file_new(const gchar *filename) {
/**
* parole_file_new_with_display_name:
* @filename: filename.
+ * @display_name: the name to display.
*
- *
+ * Create a new #ParoleFile for a file stored on the filesystem
*
* Returns: A new #ParoleFile object.
*
@@ -435,6 +436,7 @@ parole_file_new_with_display_name(const gchar *filename, const gchar *display_na
* @track_num: cd track number.
* @display_name: the track name to display.
*
+ * Create a new #ParoleFile object for a CD track number
*
* Returns: A new #ParoleFile object.
*
@@ -459,6 +461,7 @@ parole_file_new_cdda_track(const gint track_num, const gchar *display_name) {
* @chapter_num: dvd chapter number.
* @display_name: the chapter name to display.
*
+ * Create a new #ParoleFile object for a DVD chapter number
*
* Returns: A new #ParoleFile object.
*
@@ -483,6 +486,7 @@ parole_file_new_dvd_chapter(gint chapter_num, const gchar *display_name) {
* parole_file_get_file_name:
* @file: a #ParoleFile.
*
+ * Get the filename for a #ParoleFile
*
* Returns: A string containing the file name.
*
@@ -499,6 +503,7 @@ parole_file_get_file_name(const ParoleFile *file) {
* parole_file_get_display_name:
* @file: a #ParoleFile.
*
+ * Get the display name for a #ParoleFile
*
* Returns: A string containing the display name.
*
@@ -515,6 +520,7 @@ parole_file_get_display_name(const ParoleFile *file) {
* parole_file_get_uri:
* @file: a #ParoleFile.
*
+ * Get the file uri for a #ParoleFile
*
* Returns: A string containing the file uri.
*
@@ -531,6 +537,7 @@ parole_file_get_uri(const ParoleFile *file) {
* parole_file_get_content_type:
* @file: a #ParoleFile.
*
+ * Get the content type for a #ParoleFile
*
* Returns: A string containing the content type of the file.
*
@@ -547,6 +554,7 @@ parole_file_get_content_type(const ParoleFile *file) {
* parole_file_get_directory:
* @file: a #ParoleFile.
*
+ * Get the parent directory path for a #ParoleFile
*
* Returns: A string containing the parent directory path.
*
@@ -563,6 +571,7 @@ parole_file_get_directory(const ParoleFile *file) {
* parole_file_get_custom_subtitles:
* @file: a #ParoleFile.
*
+ * Get the custom subtitles path for a #ParoleFile
*
* Returns: A string containing the custom subtitles file path.
*
@@ -575,6 +584,15 @@ parole_file_get_custom_subtitles(const ParoleFile *file) {
return PAROLE_FILE_GET_PRIVATE (file)->custom_subtitles;
}
+/**
+ * parole_file_set_custom_subtitles:
+ * @file: a #ParoleFile.
+ * @suburi: uri for the subtitles file.
+ *
+ * Set the custom subtitles path for a #ParoleFile
+ *
+ * Since: 0.4
+ **/
void
parole_file_set_custom_subtitles(const ParoleFile *file, gchar *suburi) {
GValue value = G_VALUE_INIT;
@@ -594,6 +612,7 @@ parole_file_set_custom_subtitles(const ParoleFile *file, gchar *suburi) {
* parole_file_get_dvd_chapter:
* @file: a #ParoleFile.
*
+ * Get the chapter number for a #ParoleFile
*
* Returns: An int containing the dvd chapter number.
*
@@ -606,6 +625,15 @@ parole_file_get_dvd_chapter(const ParoleFile *file) {
return PAROLE_FILE_GET_PRIVATE (file)->dvd_chapter;
}
+/**
+ * parole_file_set_dvd_chapter:
+ * @file: a #ParoleFile.
+ * @dvd_chapter: chapter number to store.
+ *
+ * Set the chapter number for a #ParoleFile
+ *
+ * Since: 0.4
+ **/
void
parole_file_set_dvd_chapter(const ParoleFile *file, gint dvd_chapter) {
GValue value = G_VALUE_INIT;
diff --git a/src/misc/parole-file.h b/src/misc/parole-file.h
index b5e864b..3a2fc00 100644
--- a/src/misc/parole-file.h
+++ b/src/misc/parole-file.h
@@ -38,6 +38,13 @@ G_BEGIN_DECLS
typedef struct _ParoleFile ParoleFile;
typedef struct _ParoleFileClass ParoleFileClass;
+/**
+ * ParoleFile:
+ *
+ * File instance used by Parole.
+ *
+ * Since: 0.2
+ */
struct _ParoleFile {
GObject parent;
};
diff --git a/src/misc/parole-filters.c b/src/misc/parole-filters.c
index 21d3eea..1dfe383 100644
--- a/src/misc/parole-filters.c
+++ b/src/misc/parole-filters.c
@@ -123,6 +123,16 @@ GtkFileFilter *parole_get_supported_media_filter(void) {
return filter;
}
+/**
+ * parole_get_supported_recent_media_filter:
+ *
+ * Get a #GtkRecentFilter according to the supported
+ * Parole files mime types, including audio/video/play list formats.
+ *
+ * Returns: A #GtkRecentFilter for supported files formats.
+ *
+ * Since: 0.2
+ */
GtkRecentFilter *parole_get_supported_recent_media_filter(void) {
GtkRecentFilter *filter;
guint i;
@@ -143,7 +153,6 @@ GtkRecentFilter *parole_get_supported_recent_media_filter(void) {
/**
* parole_get_supported_files_filter:
*
- *
* Get a #GtkFileFilter according to the supported
* Parole files mime types, including audio/video/play list formats.
*
@@ -165,6 +174,16 @@ GtkFileFilter *parole_get_supported_files_filter(void) {
return filter;
}
+/**
+ * parole_get_supported_recent_files_filter:
+ *
+ * Get a #GtkRecentFilter according to the supported
+ * Parole files mime types, including audio/video/play list formats.
+ *
+ * Returns: A #GtkRecentFilter for supported files formats.
+ *
+ * Since: 0.2
+ */
GtkRecentFilter *parole_get_supported_recent_files_filter(void) {
GtkRecentFilter *filter;
guint i;
@@ -182,7 +201,6 @@ GtkRecentFilter *parole_get_supported_recent_files_filter(void) {
/**
* parole_get_supported_playlist_filter:
*
- *
* Get a #GtkFileFilter according to the supported
* Parole play-list mime types.
*
diff --git a/src/misc/parole-pl-parser.c b/src/misc/parole-pl-parser.c
index 84f086b..c1e8cd7 100644
--- a/src/misc/parole-pl-parser.c
+++ b/src/misc/parole-pl-parser.c
@@ -698,6 +698,7 @@ gboolean parole_pl_parser_save_from_files(GSList *files, const gchar *filename,
* parole_pl_parser_parse_from_file_by_extension:
* @filename: a filename.
*
+ * Parse a playlist into a series of #ParoleFile
*
* Returns: a #GSList containts a list of #ParoleFile parsed from the playlist,
* or NULL if no files were parsed.
diff --git a/src/misc/parole-provider-player.c b/src/misc/parole-provider-player.c
index 8aa4498..4b68a3f 100644
--- a/src/misc/parole-provider-player.c
+++ b/src/misc/parole-provider-player.c
@@ -130,7 +130,6 @@ static void parole_provider_player_class_init(gpointer klass) {
*
* Returns: a #GtkWidget window.
*
- *
* Since: 0.2
**/
GtkWidget *parole_provider_player_get_main_window(ParoleProviderPlayer *player) {
diff --git a/src/misc/parole-provider-player.h b/src/misc/parole-provider-player.h
index 8367711..ce01565 100644
--- a/src/misc/parole-provider-player.h
+++ b/src/misc/parole-provider-player.h
@@ -40,7 +40,24 @@ G_BEGIN_DECLS
#define PAROLE_IS_PROVIDER_PLAYER(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), PAROLE_TYPE_PROVIDER_PLAYER))
#define PAROLE_PROVIDER_PLAYER_GET_INTERFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE((o), PAROLE_TYPE_PROVIDER_PLAYER, ParoleProviderPlayerIface))
+/**
+ * ParoleProviderPlayerIface:
+ *
+ * Interface for #ParoleProviderPlayer
+ *
+ * Since: 0.2
+ */
typedef struct _ParoleProviderPlayerIface ParoleProviderPlayerIface;
+
+/**
+ * ParoleProviderPlayer:
+ *
+ * The player interface that the plugins should use in order to, issue playback
+ * commands to the Parole GStreamer backend or to get information about the
+ * current playback status.
+ *
+ * Since: 0.2
+ */
typedef struct _ParoleProviderPlayer ParoleProviderPlayer;
/**
diff --git a/src/misc/parole-provider-plugin.h b/src/misc/parole-provider-plugin.h
index bfbaa0c..0f6a9f4 100644
--- a/src/misc/parole-provider-plugin.h
+++ b/src/misc/parole-provider-plugin.h
@@ -39,7 +39,26 @@ G_BEGIN_DECLS
#define PAROLE_IS_PROVIDER_PLUGIN(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), PAROLE_TYPE_PROVIDER_PLUGIN))
#define PAROLE_PROVIDER_PLUGIN_GET_INTERFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE((o), PAROLE_TYPE_PROVIDER_PLUGIN, ParoleProviderPluginIface))
+/**
+ * ParoleProviderPluginIface:
+ *
+ * Interface for #ParoleProviderPlugin
+ *
+ * Since: 0.2
+ */
typedef struct _ParoleProviderPluginIface ParoleProviderPluginIface;
+
+/**
+ * ParoleProviderPlugin:
+ *
+ * The methods of this interface should be overridden by the plugin, the Parole
+ * player calls these methods to determine if the plugin is configurable, to ask
+ * the plugin to open its configuration dialog or to set the
+ * #ParoleProviderPlayer that the plugin can use to get access to various
+ * functionalities of the player.
+ *
+ * Since: 0.2
+ */
typedef struct _ParoleProviderPlugin ParoleProviderPlugin;
struct _ParoleProviderPluginIface {
diff --git a/src/misc/parole-stream.c b/src/misc/parole-stream.c
index 338ec87..628517a 100644
--- a/src/misc/parole-stream.c
+++ b/src/misc/parole-stream.c
@@ -375,6 +375,16 @@ parole_stream_set_image(GObject *object, GdkPixbuf *pixbuf) {
}
}
+/**
+ * parole_stream_get_image:
+ * @object: a #ParoleStream object.
+ *
+ * Get the ParoleStream image pixbuf.
+ *
+ * Returns: a #GdkPixbuf
+ *
+ * Since: 0.6
+ **/
GdkPixbuf *
parole_stream_get_image(GObject *object) {
ParoleStream *stream;
diff --git a/src/misc/parole-stream.h b/src/misc/parole-stream.h
index 5123c37..f9ec169 100644
--- a/src/misc/parole-stream.h
+++ b/src/misc/parole-stream.h
@@ -80,7 +80,16 @@ typedef enum {
PAROLE_STATE_PLAYING
} ParoleState;
-
+/**
+ * ParoleStream:
+ *
+ * This object contains all the information describing the current processed
+ * stream by Parole, this object is used with the callback function the
+ * #ParoleProviderPlayerIface::state-changed signal of the player, the plugin
+ * shouldn't take reference and all the properties are read-only for the plugins.
+ *
+ * Since: 0.2
+ */
typedef struct _ParoleStream ParoleStream;
typedef struct _ParoleStreamClass ParoleStreamClass;
diff --git a/src/misc/parole.h.in b/src/misc/parole.h.in
index df9d975..31e6f1b 100644
--- a/src/misc/parole.h.in
+++ b/src/misc/parole.h.in
@@ -37,8 +37,31 @@
#include "src/misc/parole-provider-plugin.h"
#include "src/misc/parole-stream.h"
+/**
+ * PAROLE_MAJOR_VERSION:
+ *
+ * Major version number.
+ *
+ * Since: 0.2
+ */
#define PAROLE_MAJOR_VERSION @PAROLE_VERSION_MAJOR@
+
+/**
+ * PAROLE_MINOR_VERSION:
+ *
+ * Minor version number.
+ *
+ * Since: 0.2
+ */
#define PAROLE_MINOR_VERSION @PAROLE_VERSION_MINOR@
+
+/**
+ * PAROLE_MICRO_VERSION:
+ *
+ * Micro version number.
+ *
+ * Since: 0.2
+ */
#define PAROLE_MICRO_VERSION @PAROLE_VERSION_MICRO@
/**
@@ -66,6 +89,8 @@
* @t_n: The name of the new type, in lowercase, with words separated by '_'.
* @T_P: The #GType of the parent type.
*
+ * Create a new type definition.
+ *
* Since: 0.2
*/
#define PAROLE_DEFINE_TYPE(TN, t_n, T_P) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, {})
@@ -78,6 +103,8 @@
* @_f_: #GTypeFlags to pass to g_type_module_register_type ().
* @_C_: Custom code that gets inserted in *_get_type() function.
*
+ * Create a new type definition, passing flags and custom code to be inserted in the *_get_type() function.
+ *
* Since: 0.2
*/
#define PAROLE_DEFINE_TYPE_EXTENDED(TN, t_n, T_P, _f_, _C_) _PAROLE_DEFINE_TYPE_EXTENDED_BEGIN(TN, t_n, T_P, _f_) {_C_;} _PAROLE_DEFINE_TYPE_EXTENDED_END()
@@ -89,6 +116,8 @@
* @T_P: The #GType of the parent type.
* @_C_: Custom code that gets inserted in *_get_type() function.
*
+ * Create a new type definition, passing custom code to be inserted in the *_get_type() function.
+ *
* Since: 0.2
*/
#define PAROLE_DEFINE_TYPE_WITH_CODE(TN, t_n, T_P, _C_) _PAROLE_DEFINE_TYPE_EXTENDED_BEGIN(TN, t_n, T_P, 0) {_C_;} _PAROLE_DEFINE_TYPE_EXTENDED_END()
@@ -99,6 +128,8 @@
* @t_n: The name of the new type, in lowercase, with words separated by '_'.
* @T_P: The #GType of the parent type.
*
+ * Create a new abstract type definition.
+ *
* Since: 0.2
*/
#define PAROLE_DEFINE_ABSTRACT_TYPE(TN, t_n, T_P) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, {})
@@ -110,6 +141,8 @@
* @T_P: The #GType of the parent type.
* @_C_: Custom code that gets inserted in *_get_type() function.
*
+ * Create a new abstract type definition, passing custom code to be inserted in the *_get_type() function.
+ *
* Since: 0.2
*/
#define PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE(TN, t_n, T_P, _C_) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, _C_)
@@ -170,6 +203,9 @@ type_name##_register_type (ParoleProviderPlugin *provider_plugin_def) \
* PAROLE_IMPLEMENT_INTERFACE:
* @TYPE_IFACE: the #GType of the interface to add.
* @iface_init: The interface init function.
+ *
+ * Convenience function for interface implementation.
+ *
*/
#define PAROLE_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init) \
{ \
diff --git a/src/parole-utils.c b/src/parole-utils.c
index ad95c7e..a06b68c 100644
--- a/src/parole-utils.c
+++ b/src/parole-utils.c
@@ -536,9 +536,9 @@ parole_get_uri_from_unix_device(const gchar *device) {
/**
* parole_format_media_length:
*
- * @total_seconds: lenght of the media file in seconds
+ * @total_seconds: length of the media file in seconds
*
- * Returns : formated string for the media lenght
+ * Returns : formated string for the media length
**/
gchar *parole_format_media_length(gint total_seconds) {
gchar *timestring;
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the Xfce4-commits
mailing list