[Xfce4-commits] [apps/parole] 01/01: Improve documentation quality
noreply at xfce.org
noreply at xfce.org
Fri Jun 2 12:29:58 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 072dc2cff896be5a5a591c005f31c04967e8952a
Author: Sean Davis <smd.seandavis at gmail.com>
Date: Fri Jun 2 06:29:49 2017 -0400
Improve documentation quality
---
docs/plugin-api/parole-plugins-tut.sgml | 91 ++++++++++--------------
docs/plugin-api/tmpl/parole-provider-player.sgml | 2 +-
docs/plugin-api/tmpl/parole-provider-plugin.sgml | 4 +-
docs/plugin-api/tmpl/parole-stream.sgml | 2 +-
src/gst/parole-gst.c | 4 +-
src/main.c | 16 ++---
src/misc/parole-file.c | 84 +++++++++++-----------
src/misc/parole-filters.c | 30 ++++----
src/misc/parole-pl-parser.c | 28 ++++----
src/misc/parole-provider-player.c | 52 +++++++-------
src/misc/parole-provider-plugin.c | 6 +-
src/misc/parole-stream.c | 6 +-
src/misc/parole.h.in | 54 +++++++-------
src/parole-about.c | 2 +-
src/parole-builder.c | 4 +-
src/parole-button.c | 30 ++++----
src/parole-conf.c | 52 +++++++-------
src/parole-disc.c | 56 +++++++--------
src/parole-medialist.c | 16 ++---
src/parole-module.c | 2 +-
src/parole-player.c | 8 +--
src/plugins/sample/sample-provider.c | 10 +--
src/plugins/sample/sample-provider.h | 4 +-
23 files changed, 272 insertions(+), 291 deletions(-)
diff --git a/docs/plugin-api/parole-plugins-tut.sgml b/docs/plugin-api/parole-plugins-tut.sgml
index d09f5c7..3ccced8 100644
--- a/docs/plugin-api/parole-plugins-tut.sgml
+++ b/docs/plugin-api/parole-plugins-tut.sgml
@@ -20,34 +20,32 @@
<title>Plugin structure.</title>
sample-plugin.c
<programlisting>
+#include "src/misc/parole.h"
-#include "sample-provider.h"
+#include "src/plugins/sample/sample-provider.h"
-/* Avoid a no previous function declaration compiler warning*/
-G_MODULE_EXPORT GType parole_plugin_initialize (ParoleProviderPlugin *plugin);
-G_MODULE_EXPORT void parole_plugin_shutdown (void);
+G_MODULE_EXPORT GType parole_plugin_initialize(ParoleProviderPlugin *plugin);
+
+G_MODULE_EXPORT void parole_plugin_shutdown(void);
G_MODULE_EXPORT GType
-parole_plugin_initialize (ParoleProviderPlugin *plugin)
-{
- xfce_textdomain (GETTEXT_PACKAGE, PACKAGE_LOCALE_DIR, "UTF-8");
- sample_provider_register_type (plugin);
+parole_plugin_initialize(ParoleProviderPlugin *plugin) {
+ xfce_textdomain(GETTEXT_PACKAGE, PACKAGE_LOCALE_DIR, "UTF-8");
+ sample_provider_register_type(plugin);
return SAMPLE_TYPE_PROVIDER;
}
G_MODULE_EXPORT void
-parole_plugin_shutdown (void)
-{
-
+parole_plugin_shutdown(void) {
}
</programlisting>
sample-provider.h
<programlisting>
-#ifndef SAMPLE_PROVIDER_H_
-#define SAMPLE_PROVIDER_H_
+#ifndef SRC_PLUGINS_SAMPLE_SAMPLE_PROVIDER_H_
+#define SRC_PLUGINS_SAMPLE_SAMPLE_PROVIDER_H_
-#include <src/misc/parole.h>
+#include "src/misc/parole.h"
G_BEGIN_DECLS
@@ -61,81 +59,68 @@ typedef struct _SampleProvider SampleProvider;
#define SAMPLE_IS_PROVIDER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SAMPLE_TYPE_PROVIDER))
#define SAMPLE_PROVIDER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), SAMPLE_TYPE_PROVIDER, SampleProviderClass))
-GType sample_provider_get_type (void) G_GNUC_CONST G_GNUC_INTERNAL;
+GType sample_provider_get_type (void) G_GNUC_CONST G_GNUC_INTERNAL;
-void sample_provider_register_type (ParoleProviderPlugin *plugin);
+void sample_provider_register_type (ParoleProviderPlugin *plugin);
G_END_DECLS
+
+#endif /* SRC_PLUGINS_SAMPLE_SAMPLE_PROVIDER_H_ */
</programlisting>
sample-provider.c
<programlisting>
+#include "src/plugins/sample/sample-provider.h"
-#include "sample-provider.h"
+static void sample_provider_iface_init(ParoleProviderPluginIface *iface);
+static void sample_provider_finalize(GObject *object);
-static void sample_provider_iface_init (ParoleProviderPluginIface *iface);
-static void sample_provider_finalize (GObject *object);
-
-struct _SampleProviderClass
-{
+struct _SampleProviderClass {
GObjectClass parent_class;
};
-struct _SampleProvider
-{
- GObject parent;
- ParoleProviderPlayer *player;
+struct _SampleProvider {
+ GObject parent;
+ ParoleProviderPlayer *player;
};
-PAROLE_DEFINE_TYPE_WITH_CODE (SampleProvider,
- sample_provider,
- G_TYPE_OBJECT,
- PAROLE_IMPLEMENT_INTERFACE (PAROLE_TYPE_PROVIDER_PLUGIN,
- sample_provider_iface_init));
-
-static void sample_provider_configure (ParoleProviderPlugin *provider, GtkWidget *parent)
-{
- /*Open the configuration dialog, parent is the window transient for*/
-}
+PAROLE_DEFINE_TYPE_WITH_CODE(SampleProvider,
+ sample_provider,
+ G_TYPE_OBJECT,
+ PAROLE_IMPLEMENT_INTERFACE(PAROLE_TYPE_PROVIDER_PLUGIN,
+ sample_provider_iface_init));
-static gboolean sample_provider_is_configurable (ParoleProviderPlugin *plugin)
-{
- return TRUE; /*Returns FALSE and don't override the iface->configure function*/
+static gboolean sample_provider_is_configurable(ParoleProviderPlugin *plugin) {
+ return FALSE;
}
static void
-sample_provider_set_player (ParoleProviderPlugin *plugin, ParoleProviderPlayer *player)
-{
+sample_provider_set_player(ParoleProviderPlugin *plugin, ParoleProviderPlayer *player) {
SampleProvider *provider;
- provider = SAMPLE_PROVIDER (plugin);
+ provider = SAMPLE_PROVIDER(plugin);
provider->player = player;
}
static void
-sample_provider_iface_init (ParoleProviderPluginIface *iface)
-{
+sample_provider_iface_init(ParoleProviderPluginIface *iface) {
iface->get_is_configurable = sample_provider_is_configurable;
- iface->configure = sample_provider_configure;
iface->set_player = sample_provider_set_player;
}
-static void sample_provider_class_init (SampleProviderClass *klass)
-{
- GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+static void sample_provider_class_init(SampleProviderClass *klass) {
+ GObjectClass *gobject_class = G_OBJECT_CLASS(klass);
gobject_class->finalize = sample_provider_finalize;
}
-static void sample_provider_init (SampleProvider *provider)
-{
+static void sample_provider_init(SampleProvider *provider) {
provider->player = NULL;
}
-static void sample_provider_finalize (GObject *object)
-{
- G_OBJECT_CLASS (sample_provider_parent_class)->finalize (object);
+static void sample_provider_finalize(GObject *object) {
+ G_OBJECT_CLASS(sample_provider_parent_class)->finalize(object);
}
</programlisting>
diff --git a/docs/plugin-api/tmpl/parole-provider-player.sgml b/docs/plugin-api/tmpl/parole-provider-player.sgml
index 73c3006..e1e281f 100644
--- a/docs/plugin-api/tmpl/parole-provider-player.sgml
+++ b/docs/plugin-api/tmpl/parole-provider-player.sgml
@@ -2,7 +2,7 @@
ParoleProviderPlayer
<!-- ##### SECTION Short_Description ##### -->
-The interface of the player.
+Player interface
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/plugin-api/tmpl/parole-provider-plugin.sgml b/docs/plugin-api/tmpl/parole-provider-plugin.sgml
index bd88e3d..0befd82 100644
--- a/docs/plugin-api/tmpl/parole-provider-plugin.sgml
+++ b/docs/plugin-api/tmpl/parole-provider-plugin.sgml
@@ -2,7 +2,7 @@
ParoleProviderPlugin
<!-- ##### SECTION Short_Description ##### -->
-The interface of the plugin type registration.
+Plugin type registration interface
<!-- ##### SECTION Long_Description ##### -->
<para>
@@ -54,5 +54,3 @@ can use to get access to various functionalities of the player.
@provider:
@player:
-
-
diff --git a/docs/plugin-api/tmpl/parole-stream.sgml b/docs/plugin-api/tmpl/parole-stream.sgml
index 0ac63f5..66860b6 100644
--- a/docs/plugin-api/tmpl/parole-stream.sgml
+++ b/docs/plugin-api/tmpl/parole-stream.sgml
@@ -2,7 +2,7 @@
ParoleStream
<!-- ##### SECTION Short_Description ##### -->
-Currently playing stream.
+Playback stream interface
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/src/gst/parole-gst.c b/src/gst/parole-gst.c
index e302594..2422cf3 100644
--- a/src/gst/parole-gst.c
+++ b/src/gst/parole-gst.c
@@ -1258,8 +1258,8 @@ parole_gst_application_message(ParoleGst *gst, GstMessage *msg) {
/**
* parole_gst_install_plugins_result_func:
- * @result : %GST_INSTALL_PLUGINS_SUCCESS (0) if successful.
- * @user_data : gst instance passed as user_data for callback function.
+ * @result : %GST_INSTALL_PLUGINS_SUCCESS (0) if successful
+ * @user_data : gst instance passed as user_data for callback function
*
* Callback function for when asynchronous codec installation finishes. Update
* the gstreamer plugin registry and restart playback.
diff --git a/src/main.c b/src/main.c
index a17dc2a..de66832 100644
--- a/src/main.c
+++ b/src/main.c
@@ -74,8 +74,8 @@ parole_sig_handler(gint sig, gpointer data) {
/**
* parole_send_play_disc:
- * @uri : the URI address of a disc or %NULL.
- * @device : the UNIX device for a disc or %NULL.
+ * @uri : the URI address of a disc or %NULL
+ * @device : the UNIX device for a disc or %NULL
*
* Load the discs that is passed as a cli argument to Parole.
**/
@@ -111,9 +111,9 @@ parole_send_play_disc(const gchar *uri, const gchar *device) {
/**
* parole_send_files:
- * @filenames : the list of files to be played in Parole.
+ * @filenames : the list of files to be played in Parole
* @enqueue : %TRUE if files should be added to the playlist or %FALSE if the
- * playlist should be replaced.
+ * playlist should be replaced
*
* Load files that are passed as cli arguments to Parole.
**/
@@ -156,10 +156,10 @@ parole_send_files(gchar **filenames, gboolean enqueue) {
/**
* parole_send:
- * @filenames : a list of files to be played.
- * @device : a URI pointing to a disc to be played or %NULL.
+ * @filenames : a list of files to be played
+ * @device : a URI pointing to a disc to be played or %NULL
* @enqueue : %TRUE if files should be added to the playlist or %FALSE if the
- * playlist should be replaced.
+ * playlist should be replaced
*
* Load the files or device that are passed as cli arguments to Parole.
**/
@@ -173,7 +173,7 @@ parole_send(gchar **filenames, gchar *device, gboolean enqueue) {
/**
* parole_send_message:
- * @message : message string to be sent to DBUS.
+ * @message : message string to be sent to DBUS
*
* Send a message via DBUS to Parole.
**/
diff --git a/src/misc/parole-file.c b/src/misc/parole-file.c
index e32205d..7d0fcbc 100644
--- a/src/misc/parole-file.c
+++ b/src/misc/parole-file.c
@@ -393,11 +393,11 @@ parole_file_init(ParoleFile *file) {
/**
* parole_file_new:
- * @filename: filename.
+ * @filename: filename
*
- * Create a new #ParoleFile
+ * Create a new #ParoleFile.
*
- * Returns: A new #ParoleFile object.
+ * Returns: A new #ParoleFile object
*
* Since: 0.2
**/
@@ -410,12 +410,12 @@ parole_file_new(const gchar *filename) {
/**
* parole_file_new_with_display_name:
- * @filename: filename.
- * @display_name: the name to display.
+ * @filename: filename
+ * @display_name: the name to display
*
- * Create a new #ParoleFile for a file stored on the filesystem
+ * Create a new #ParoleFile for a file stored on the filesystem.
*
- * Returns: A new #ParoleFile object.
+ * Returns: A new #ParoleFile object
*
* Since: 0.2
**/
@@ -433,12 +433,12 @@ parole_file_new_with_display_name(const gchar *filename, const gchar *display_na
/**
* parole_file_new_cdda_track:
- * @track_num: cd track number.
- * @display_name: the track name to display.
+ * @track_num: cd track number
+ * @display_name: the track name to display
*
- * Create a new #ParoleFile object for a CD track number
+ * Create a new #ParoleFile object for a CD track number.
*
- * Returns: A new #ParoleFile object.
+ * Returns: A new #ParoleFile object
*
* Since: 0.4
**/
@@ -458,12 +458,12 @@ parole_file_new_cdda_track(const gint track_num, const gchar *display_name) {
/**
* parole_file_new_dvd_chapter:
- * @chapter_num: dvd chapter number.
- * @display_name: the chapter name to display.
+ * @chapter_num: dvd chapter number
+ * @display_name: the chapter name to display
*
- * Create a new #ParoleFile object for a DVD chapter number
+ * Create a new #ParoleFile object for a DVD chapter number.
*
- * Returns: A new #ParoleFile object.
+ * Returns: A new #ParoleFile object
*
* Since: 0.4
**/
@@ -484,11 +484,11 @@ parole_file_new_dvd_chapter(gint chapter_num, const gchar *display_name) {
/**
* parole_file_get_file_name:
- * @file: a #ParoleFile.
+ * @file: a #ParoleFile
*
- * Get the filename for a #ParoleFile
+ * Get the filename for a #ParoleFile.
*
- * Returns: A string containing the file name.
+ * Returns: A string containing the file name
*
* Since: 0.2
**/
@@ -501,11 +501,11 @@ parole_file_get_file_name(const ParoleFile *file) {
/**
* parole_file_get_display_name:
- * @file: a #ParoleFile.
+ * @file: a #ParoleFile
*
- * Get the display name for a #ParoleFile
+ * Get the display name for a #ParoleFile.
*
- * Returns: A string containing the display name.
+ * Returns: A string containing the display name
*
* Since: 0.2
**/
@@ -518,11 +518,11 @@ parole_file_get_display_name(const ParoleFile *file) {
/**
* parole_file_get_uri:
- * @file: a #ParoleFile.
+ * @file: a #ParoleFile
*
- * Get the file uri for a #ParoleFile
+ * Get the file uri for a #ParoleFile.
*
- * Returns: A string containing the file uri.
+ * Returns: A string containing the file uri
*
* Since: 0.2
**/
@@ -535,11 +535,11 @@ parole_file_get_uri(const ParoleFile *file) {
/**
* parole_file_get_content_type:
- * @file: a #ParoleFile.
+ * @file: a #ParoleFile
*
- * Get the content type for a #ParoleFile
+ * Get the content type for a #ParoleFile.
*
- * Returns: A string containing the content type of the file.
+ * Returns: A string containing the content type of the file
*
* Since: 0.2
**/
@@ -552,11 +552,11 @@ parole_file_get_content_type(const ParoleFile *file) {
/**
* parole_file_get_directory:
- * @file: a #ParoleFile.
+ * @file: a #ParoleFile
*
- * Get the parent directory path for a #ParoleFile
+ * Get the parent directory path for a #ParoleFile.
*
- * Returns: A string containing the parent directory path.
+ * Returns: A string containing the parent directory path
*
* Since: 0.2
**/
@@ -569,11 +569,11 @@ parole_file_get_directory(const ParoleFile *file) {
/**
* parole_file_get_custom_subtitles:
- * @file: a #ParoleFile.
+ * @file: a #ParoleFile
*
- * Get the custom subtitles path for a #ParoleFile
+ * Get the custom subtitles path for a #ParoleFile.
*
- * Returns: A string containing the custom subtitles file path.
+ * Returns: A string containing the custom subtitles file path
*
* Since: 0.4
**/
@@ -586,10 +586,10 @@ parole_file_get_custom_subtitles(const ParoleFile *file) {
/**
* parole_file_set_custom_subtitles:
- * @file: a #ParoleFile.
- * @suburi: uri for the subtitles file.
+ * @file: a #ParoleFile
+ * @suburi: uri for the subtitles file
*
- * Set the custom subtitles path for a #ParoleFile
+ * Set the custom subtitles path for a #ParoleFile.
*
* Since: 0.4
**/
@@ -610,11 +610,11 @@ parole_file_set_custom_subtitles(const ParoleFile *file, gchar *suburi) {
/**
* parole_file_get_dvd_chapter:
- * @file: a #ParoleFile.
+ * @file: a #ParoleFile
*
- * Get the chapter number for a #ParoleFile
+ * Get the chapter number for a #ParoleFile.
*
- * Returns: An int containing the dvd chapter number.
+ * Returns: An int containing the dvd chapter number
*
* Since: 0.4
**/
@@ -627,10 +627,10 @@ parole_file_get_dvd_chapter(const ParoleFile *file) {
/**
* parole_file_set_dvd_chapter:
- * @file: a #ParoleFile.
- * @dvd_chapter: chapter number to store.
+ * @file: a #ParoleFile
+ * @dvd_chapter: chapter number to store
*
- * Set the chapter number for a #ParoleFile
+ * Set the chapter number for a #ParoleFile.
*
* Since: 0.4
**/
diff --git a/src/misc/parole-filters.c b/src/misc/parole-filters.c
index 1dfe383..c15f018 100644
--- a/src/misc/parole-filters.c
+++ b/src/misc/parole-filters.c
@@ -53,7 +53,7 @@ static char *playlist_file_extensions[] = {
* Get a #GtkFileFilter according to the supported
* Parole audio mime types.
*
- * Returns: A #GtkFileFilter for supported audio formats.
+ * Returns: A #GtkFileFilter for supported audio formats
*
* Since: 0.2
*/
@@ -78,7 +78,7 @@ GtkFileFilter *parole_get_supported_audio_filter(void) {
* Get a #GtkFileFilter according to the supported
* Parole video mime types.
*
- * Returns: A #GtkFileFilter for supported video formats.
+ * Returns: A #GtkFileFilter for supported video formats
*
* Since: 0.2
*/
@@ -100,9 +100,9 @@ GtkFileFilter *parole_get_supported_video_filter(void) {
* parole_get_supported_media_filter:
*
* Get a #GtkFileFilter according to the supported
- * Parole media mime types, including audio and vide.
+ * Parole media mime types, including audio and video.
*
- * Returns: A #GtkFileFilter for supported media formats.
+ * Returns: A #GtkFileFilter for supported media formats
*
* Since: 0.2
*/
@@ -127,9 +127,9 @@ GtkFileFilter *parole_get_supported_media_filter(void) {
* parole_get_supported_recent_media_filter:
*
* Get a #GtkRecentFilter according to the supported
- * Parole files mime types, including audio/video/play list formats.
+ * Parole file mime types, including audio/video/playlist formats.
*
- * Returns: A #GtkRecentFilter for supported files formats.
+ * Returns: A #GtkRecentFilter for supported files formats
*
* Since: 0.2
*/
@@ -154,9 +154,9 @@ 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.
+ * Parole file mime types, including audio/video/playlist formats.
*
- * Returns: A #GtkFileFilter for supported files formats.
+ * Returns: A #GtkFileFilter for supported files formats
*
* Since: 0.2
*/
@@ -178,9 +178,9 @@ GtkFileFilter *parole_get_supported_files_filter(void) {
* parole_get_supported_recent_files_filter:
*
* Get a #GtkRecentFilter according to the supported
- * Parole files mime types, including audio/video/play list formats.
+ * Parole file mime types, including audio/video/playlist formats.
*
- * Returns: A #GtkRecentFilter for supported files formats.
+ * Returns: A #GtkRecentFilter for supported files formats
*
* Since: 0.2
*/
@@ -202,9 +202,9 @@ 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.
+ * Parole playlist mime types.
*
- * Returns: A #GtkFileFilter for supported playlist formats.
+ * Returns: A #GtkFileFilter for supported playlist formats
*
* Since: 0.2
*/
@@ -224,12 +224,12 @@ GtkFileFilter *parole_get_supported_playlist_filter(void) {
/**
* parole_file_filter:
- * @filter: a #GtkFileFilter.
+ * @filter: a #GtkFileFilter
* @file: a #ParoleFile
*
- * Tests whether a file should be displayed according to filter
+ * Tests whether a file should be displayed according to filter.
*
- * Returns: TRUE if the file should be displayed.
+ * Returns: TRUE if the file should be displayed
*
* Since: 0.2
*/
diff --git a/src/misc/parole-pl-parser.c b/src/misc/parole-pl-parser.c
index c1e8cd7..3fe5c89 100644
--- a/src/misc/parole-pl-parser.c
+++ b/src/misc/parole-pl-parser.c
@@ -580,12 +580,12 @@ parole_pl_parser_save_xspf(FILE *f, GSList *files) {
/**
* parole_pl_parser_guess_format_from_extension:
- * @filename: a filename.
+ * @filename: a filename
*
* Guess a playlist format from the filename extension.
*
* Returns: PAROLE_PL_FORMAT_UNKNOWN if unable to get the playlist format, and a valid
- * playlist format otherwise.
+ * playlist format otherwise
*
* Since: 0.2
*/
@@ -611,12 +611,12 @@ parole_pl_parser_guess_format_from_extension(const gchar *filename) {
/**
* parole_pl_parser_guess_format_from_data:
- * @filename: a filename.
+ * @filename: a filename
*
* Guess a playlist format from its data.
*
* Returns: PAROLE_PL_FORMAT_UNKNOWN if unable to get the playlist format, and a valid
- * playlist format otherwise.
+ * playlist format otherwise
*
* Since: 0.2
*/
@@ -653,14 +653,14 @@ out:
/**
* parole_pl_parser_save_from_files:
- * @files: a #GSList list of #ParoleFile files.
- * @filename: a filename to save.
- * @format: a #ParolePlFormat format of the playlist.
+ * @files: a #GSList list of #ParoleFile files
+ * @filename: a filename to save
+ * @format: a #ParolePlFormat format of the playlist
*
* Saves a #GSList containing a list of #ParoleFile files to filename.
*
*
- * Returns: TRUE if the playlist was saved, FALSE otherwise.
+ * Returns: TRUE if the playlist was saved, FALSE otherwise
*
* Since: 0.2
**/
@@ -696,12 +696,12 @@ gboolean parole_pl_parser_save_from_files(GSList *files, const gchar *filename,
/**
* parole_pl_parser_parse_from_file_by_extension:
- * @filename: a filename.
+ * @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.
+ * or NULL if no files were parsed
*
* Since: 0.2
*/
@@ -730,7 +730,7 @@ out:
*
*
* Returns: a #GSList containts a list of #ParoleFile parsed from the playlist,
- * or NULL if no files were parsed.
+ * or NULL if no files were parsed
*
* Since: 0.2
*/
@@ -747,12 +747,12 @@ GSList *parole_pl_parser_parse_all_from_file(const gchar *filename) {
/**
* parole_pl_parser_can_parse_data:
- * @data: data.
- * @len: length of data.
+ * @data: data
+ * @len: length of data
*
* Get if the Parole parser can parse from the passed data.
*
- * Returns: TRUE if it can parse from the data, FALSE otherwise.
+ * Returns: TRUE if it can parse from the data, FALSE otherwise
*
* Since: 0.2
*/
diff --git a/src/misc/parole-provider-player.c b/src/misc/parole-provider-player.c
index 4b68a3f..94e16cd 100644
--- a/src/misc/parole-provider-player.c
+++ b/src/misc/parole-provider-player.c
@@ -64,9 +64,9 @@ static void parole_provider_player_base_init(gpointer klass) {
if (G_UNLIKELY(!initialized)) {
/**
* ParoleProviderPlayerIface::state-changed:
- * @player: the object which received the signal.
- * @stream: a #ParoleStream.
- * @state: the new state.
+ * @player: the object which received the signal
+ * @stream: a #ParoleStream
+ * @state: the new state
*
* Issued when the Parole state changed.
*
@@ -83,10 +83,10 @@ static void parole_provider_player_base_init(gpointer klass) {
/**
* ParoleProviderPlayerIface::tag-message:
- * @player: the object which received the signal.
- * @stream: a #ParoleStream.
+ * @player: the object which received the signal
+ * @stream: a #ParoleStream
*
- * Indicated that the stream tags were found and ready to be read.
+ * Indicates that the stream tags were found and ready to be read.
*
* Since: 0.2
**/
@@ -100,8 +100,8 @@ static void parole_provider_player_base_init(gpointer klass) {
/**
* ParoleProviderPlayerIface::seeked:
- * @player: the object which received the signal.
- * @value: the seeked position.
+ * @player: the object which received the signal
+ * @value: the seeked position
*
* Notifies when the stream has been manually advanced.
*
@@ -128,7 +128,7 @@ static void parole_provider_player_class_init(gpointer klass) {
*
* Ask the Player to get the Parole main window.
*
- * Returns: a #GtkWidget window.
+ * Returns: a #GtkWidget window
*
* Since: 0.2
**/
@@ -146,9 +146,9 @@ GtkWidget *parole_provider_player_get_main_window(ParoleProviderPlayer *player)
/**
* parole_provider_player_pack:
* @player: a #ParoleProviderPlayer
- * @widget: a #GtkWidget.
+ * @widget: a #GtkWidget
* @title: title
- * @container: a #ParolePluginContainer.
+ * @container: a #ParolePluginContainer
*
* Ask the player to pack a widget in the playlist notebook if PAROLE_PLUGIN_CONTAINER_PLAYLIST
* is specified or in the main window notebook if PAROLE_PLUGIN_CONTAINER_MAIN_VIEW is specified.
@@ -174,7 +174,7 @@ void parole_provider_player_pack(ParoleProviderPlayer *player, GtkWidget *widget
*
* Get the current state of the player.
*
- * Returns: a #ParoleState.
+ * Returns: a #ParoleState
*
*
* Since: 0.2
@@ -197,7 +197,7 @@ ParoleState parole_provider_player_get_state(ParoleProviderPlayer *player) {
*
* Get the #ParoleStream object.
*
- * Returns: the #ParoleStream object.
+ * Returns: the #ParoleStream object
*
* Since: 0.2
**/
@@ -222,7 +222,7 @@ const ParoleStream *parole_provider_player_get_stream(ParoleProviderPlayer *play
* Returning TRUE doesn't mean that the funtion succeeded to change the state of the player,
* the state change is indicated asynchronously by #ParoleProviderPlayerIface::state-changed signal.
*
- * Returns: TRUE if the command is processed, FALSE otherwise.
+ * Returns: TRUE if the command is processed, FALSE otherwise
*
* Since: 0.2
**/
@@ -248,7 +248,7 @@ gboolean parole_provider_player_play_uri(ParoleProviderPlayer *player, const gch
* Returning TRUE doesn't mean that the funtion succeeded to change the state of the player,
* the state change is indicated asynchronously by #ParoleProviderPlayerIface::state-changed signal.
*
- * Returns: TRUE if the command is processed, FALSE otherwise.
+ * Returns: TRUE if the command is processed, FALSE otherwise
*
*
* Since: 0.2
@@ -277,7 +277,7 @@ gboolean parole_provider_player_pause(ParoleProviderPlayer *player) {
* Returning TRUE doesn't mean that the funtion succeeded to change the state of the player,
* the state change is indicated asynchronously by #ParoleProviderPlayerIface::state-changed signal.
*
- * Returns: TRUE if the command is processed, FALSE otherwise.
+ * Returns: TRUE if the command is processed, FALSE otherwise
*
*
* Since: 0.2
@@ -304,7 +304,7 @@ gboolean parole_provider_player_resume(ParoleProviderPlayer *player) {
* Returning TRUE doesn't mean that the funtion succeeded to change the state of the player,
* the state change is indicated asynchronously by #ParoleProviderPlayerIface::state-changed signal.
*
- * Returns: TRUE if the command is processed, FALSE otherwise.
+ * Returns: TRUE if the command is processed, FALSE otherwise
*
* Since: 0.2
**/
@@ -327,7 +327,7 @@ gboolean parole_provider_player_stop(ParoleProviderPlayer *player) {
*
* Issue a play previous command to the player.
*
- * Returns: TRUE if the command is processed, FALSE otherwise.
+ * Returns: TRUE if the command is processed, FALSE otherwise
*
* Since: 0.6
**/
@@ -350,7 +350,7 @@ gboolean parole_provider_player_play_previous(ParoleProviderPlayer *player) {
*
* Issue a play next command to the player.
*
- * Returns: TRUE if the command is processed, FALSE otherwise.
+ * Returns: TRUE if the command is processed, FALSE otherwise
*
* Since: 0.6
**/
@@ -370,12 +370,12 @@ gboolean parole_provider_player_play_next(ParoleProviderPlayer *player) {
/**
* parole_provider_player_seek:
* @player: a #ParoleProviderPlayer
- * @pos: position to seek.
+ * @pos: position to seek
*
*
* Issue a seek command.
*
- * Returns: TRUE if the seek command succeeded, FALSE otherwise.
+ * Returns: TRUE if the seek command succeeded, FALSE otherwise
*
*
* Since: 0.2
@@ -396,9 +396,9 @@ gboolean parole_provider_player_seek(ParoleProviderPlayer *player, gdouble pos)
* parole_provider_player_get_stream_position:
* @player: a #ParoleProviderPlayer
*
- * Get stream position (microseconds) for Parole.
+ * Get the stream position (in microseconds) for Parole.
*
- * Returns: a #gdouble containing the current stream position in microseconds.
+ * Returns: a #gdouble containing the current stream position in microseconds
*
* Since: 0.6
**/
@@ -436,7 +436,7 @@ void parole_provider_player_open_media_chooser(ParoleProviderPlayer *player) {
*
* Get GSimpleAction from Parole.
*
- * Returns: the requested #GSimpleAction.
+ * Returns: the requested #GSimpleAction
*
*
* Since: 0.6
@@ -459,7 +459,7 @@ GSimpleAction *parole_provider_player_get_action(ParoleProviderPlayer *player, P
*
* Get fullscreen status for Parole.
*
- * Returns: TRUE if the player window is fullscreen, FALSE otherwise.
+ * Returns: TRUE if the player window is fullscreen, FALSE otherwise
*
* Since: 0.6
**/
@@ -480,7 +480,7 @@ gboolean parole_provider_player_get_fullscreen(ParoleProviderPlayer *player) {
*
* Set fullscreen status for Parole.
*
- * Returns: TRUE if the fullscreen command succeeded, FALSE otherwise.
+ * Returns: TRUE if the fullscreen command succeeded, FALSE otherwise
*
* Since: 0.6
**/
diff --git a/src/misc/parole-provider-plugin.c b/src/misc/parole-provider-plugin.c
index 7604603..7ad89f9 100644
--- a/src/misc/parole-provider-plugin.c
+++ b/src/misc/parole-provider-plugin.c
@@ -54,9 +54,9 @@ parole_provider_plugin_get_type(void) {
* parole_provider_plugin_get_is_configurable:
* @provider: a #ParoleProviderPlugin
*
- * Get if the plugin is configurable.
+ * Check if the plugin is configurable.
*
- * Returns: TRUE if the plugin is configurable, FALSE otherwise.
+ * Returns: TRUE if the plugin is configurable, FALSE otherwise
*
*
* Since: 0.2
@@ -78,7 +78,7 @@ gboolean parole_provider_plugin_get_is_configurable(ParoleProviderPlugin *provid
* @provider: a #ParoleProviderPlugin
* @parent: a #GtkWidget parent window
*
- * Open the plugin configuration dialog
+ * Open the plugin configuration dialog.
*
*
* Since: 0.2
diff --git a/src/misc/parole-stream.c b/src/misc/parole-stream.c
index 628517a..17cde49 100644
--- a/src/misc/parole-stream.c
+++ b/src/misc/parole-stream.c
@@ -338,8 +338,8 @@ parole_stream_finalize(GObject *object) {
/**
* parole_stream_set_image:
- * @object: a #ParoleStream object.
- * @pixbuf: a #GdkPixbuf to set as the stream image.
+ * @object: a #ParoleStream object
+ * @pixbuf: a #GdkPixbuf to set as the stream image
*
* Set the ParoleStream image to a new pixbuf.
*
@@ -377,7 +377,7 @@ parole_stream_set_image(GObject *object, GdkPixbuf *pixbuf) {
/**
* parole_stream_get_image:
- * @object: a #ParoleStream object.
+ * @object: a #ParoleStream object
*
* Get the ParoleStream image pixbuf.
*
diff --git a/src/misc/parole.h.in b/src/misc/parole.h.in
index 31e6f1b..140b380 100644
--- a/src/misc/parole.h.in
+++ b/src/misc/parole.h.in
@@ -66,9 +66,9 @@
/**
* PAROLE_CHECK_VERSION:
- * @major: major version number.
- * @minor: minor version number.
- * @micro: micor version number.
+ * @major: major version number
+ * @minor: minor version number
+ * @micro: micor version number
*
* Checks the parole version.
*
@@ -85,23 +85,23 @@
*/
/**
* PAROLE_DEFINE_TYPE:
- * @TN: The name of the new type, in Camel case.
- * @t_n: The name of the new type, in lowercase, with words separated by '_'.
- * @T_P: The #GType of the parent type.
+ * @TN: The name of the new type, in Camel case
+ * @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, {})
+#define PAROLE_DEFINE_TYPE(TN, t_n, T_P) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, {})
/**
* PAROLE_DEFINE_TYPE_EXTENDED:
- * @TN: The name of the new type, in Camel case.
- * @t_n: The name of the new type, in lowercase, with words separated by '_'.
- * @T_P: The #GType of the parent type.
- * @_f_: #GTypeFlags to pass to g_type_module_register_type ().
- * @_C_: Custom code that gets inserted in *_get_type() function.
+ * @TN: The name of the new type, in Camel case
+ * @t_n: The name of the new type, in lowercase, with words separated by '_'
+ * @T_P: The #GType of the parent type
+ * @_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.
*
@@ -111,35 +111,35 @@
/**
* PAROLE_DEFINE_TYPE_WITH_CODE:
- * @TN: The name of the new type, in Camel case.
- * @t_n: The name of the new type, in lowercase, with words separated by '_'.
- * @T_P: The #GType of the parent type.
- * @_C_: Custom code that gets inserted in *_get_type() function.
+ * @TN: The name of the new type, in Camel case
+ * @t_n: The name of the new type, in lowercase, with words separated by '_'
+ * @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()
+#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()
/**
* PAROLE_DEFINE_ABSTRACT_TYPE:
- * @TN: The name of the new type, in Camel case.
- * @t_n: The name of the new type, in lowercase, with words separated by '_'.
- * @T_P: The #GType of the parent type.
+ * @TN: The name of the new type, in Camel case
+ * @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, {})
+#define PAROLE_DEFINE_ABSTRACT_TYPE(TN, t_n, T_P) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, {})
/**
* PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE:
- * @TN: The name of the new type, in Camel case.
- * @t_n: The name of the new type, in lowercase, with words separated by '_'.
- * @T_P: The #GType of the parent type.
- * @_C_: Custom code that gets inserted in *_get_type() function.
+ * @TN: The name of the new type, in Camel case
+ * @t_n: The name of the new type, in lowercase, with words separated by '_'
+ * @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.
*
@@ -201,8 +201,8 @@ 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.
+ * @TYPE_IFACE: the #GType of the interface to add
+ * @iface_init: The interface init function
*
* Convenience function for interface implementation.
*
diff --git a/src/parole-about.c b/src/parole-about.c
index 11a3330..3ecf169 100644
--- a/src/parole-about.c
+++ b/src/parole-about.c
@@ -38,7 +38,7 @@
/**
* parole_about:
- * @parent : the parent application window.
+ * @parent : the parent application window
*
* Display the About dialog for Parole.
**/
diff --git a/src/parole-builder.c b/src/parole-builder.c
index 5bedf52..b00c0a6 100644
--- a/src/parole-builder.c
+++ b/src/parole-builder.c
@@ -56,8 +56,8 @@ parole_builder_get_main_interface(void) {
/**
* parole_builder_new_from_string:
- * @ui : the string containing parole's condensed glade interface.
- * @length : the length of the ui string.
+ * @ui : the string containing parole's condensed glade interface
+ * @length : the length of the ui string
*
* Build Parole's UI from the condensed glade string.
**/
diff --git a/src/parole-button.c b/src/parole-button.c
index 989a14d..6678692 100644
--- a/src/parole-button.c
+++ b/src/parole-button.c
@@ -80,7 +80,7 @@ G_DEFINE_TYPE(ParoleButton, parole_button, G_TYPE_OBJECT)
/**
* parole_button_get_key:
- * @keycode : an #int representing a key on a keyboard.
+ * @keycode : an #int representing a key on a keyboard
*
* Check if the pressed key is mapped to a function in Parole.
**/
@@ -100,9 +100,9 @@ parole_button_get_key(unsigned int keycode) {
/**
* parole_button_filter_x_events:
- * @xevent : a #GdkXEvent to filter.
- * @ev : the #GdkEvent passed by the callback function.
- * @data : user-data passed by the callback function.
+ * @xevent : a #GdkXEvent to filter
+ * @ev : the #GdkEvent passed by the callback function
+ * @data : user-data passed by the callback function
*
* Filter X events for keypresses, and pass the keypresses on to be processed.
**/
@@ -132,12 +132,12 @@ parole_button_filter_x_events(GdkXEvent *xevent, GdkEvent *ev, gpointer data) {
/**
* parole_button_grab_keystring:
- * @button : the #ParoleButton instance to handle keypresses.
- * @keycode : the #int representing the pressed key on the keyboard.
+ * @button : the #ParoleButton instance to handle keypresses
+ * @keycode : the #int representing the pressed key on the keyboard
*
* Attempt to get the pressed key and modifier keys.
*
- * Return value: %TRUE on success, else %FALSE.
+ * Return value: %TRUE on success, else %FALSE
**/
static gboolean
parole_button_grab_keystring(ParoleButton *button, guint keycode) {
@@ -176,13 +176,13 @@ parole_button_grab_keystring(ParoleButton *button, guint keycode) {
/**
* parole_button_xevent_key:
- * @button : the #ParoleButton instance to handle keypresses.
- * @keysym : an #int representing the keysym to be converted to a keycode.
- * @key : the #ParoleButtonKey that represents the pressed key.
+ * @button : the #ParoleButton instance to handle keypresses
+ * @keysym : an #int representing the keysym to be converted to a keycode
+ * @key : the #ParoleButtonKey that represents the pressed key
*
* Attempt to map the key and keycode to the parole_key_map.
*
- * Return value: %TRUE on success, else %FALSE.
+ * Return value: %TRUE on success, else %FALSE
**/
static gboolean
parole_button_xevent_key(ParoleButton *button, guint keysym , ParoleButtonKey key) {
@@ -208,7 +208,7 @@ parole_button_xevent_key(ParoleButton *button, guint keysym , ParoleButtonKey ke
/**
* parole_button_setup:
- * @button : the #ParoleButton instance to handle keypresses.
+ * @button : the #ParoleButton instance to handle keypresses
*
* Setup Parole's keyboard mappings.
**/
@@ -228,7 +228,7 @@ parole_button_setup(ParoleButton *button) {
/**
* parole_button_class_init:
- * @klass: a #ParoleButtonClass instance.
+ * @klass: a #ParoleButtonClass instance
*
* Initialize a #ParoleButtonClass instance.
**/
@@ -252,7 +252,7 @@ parole_button_class_init(ParoleButtonClass *klass) {
/**
* parole_button_init:
- * @button : a #ParoleButton instance.
+ * @button : a #ParoleButton instance
*
* Initialize a #ParoleButton instance.
**/
@@ -268,7 +268,7 @@ parole_button_init(ParoleButton *button) {
/**
* parole_button_finalize:
- * @object : a base #GObject to be made into a #ParoleButton object.
+ * @object : a base #GObject to be made into a #ParoleButton object
*
* Finalize a #ParoleButton object.
**/
diff --git a/src/parole-conf.c b/src/parole-conf.c
index 57c9e47..f0ea2fc 100644
--- a/src/parole-conf.c
+++ b/src/parole-conf.c
@@ -133,10 +133,10 @@ G_DEFINE_TYPE(ParoleConf, parole_conf, G_TYPE_OBJECT)
/**
* parole_conf_set_property:
- * @object : a #ParoleConf instance passed as #GObject.
- * @prop_id : the ID of the property being set.
- * @value : the value of the property being set.
- * @pspec : the property #GParamSpec.
+ * @object : a #ParoleConf instance passed as #GObject
+ * @prop_id : the ID of the property being set
+ * @value : the value of the property being set
+ * @pspec : the property #GParamSpec
*
* Write property-values to the Xfconf channel.
**/
@@ -201,10 +201,10 @@ static void parole_conf_set_property(GObject *object,
/**
* parole_conf_get_property:
- * @object : a #ParoleConf instance passed as #GObject.
- * @prop_id : the ID of the property being retrieved.
- * @value : the return variable for the value of the property being retrieved.
- * @pspec : the property #GParamSpec.
+ * @object : a #ParoleConf instance passed as #GObject
+ * @prop_id : the ID of the property being retrieved
+ * @value : the return variable for the value of the property being retrieved
+ * @pspec : the property #GParamSpec
*
* Read property-values from the Xfconf channel
**/
@@ -312,10 +312,10 @@ gchar *parole_conf_map_xfconf_property_name(const gchar *prop_name) {
/**
* parole_conf_prop_changed:
- * @channel : the #XfconfChannel where settings are stored.
- * @prop_name : the name of the property being modified.
- * @value : the updated value of the property being modified.
- * @conf : the #ParoleConf instance.
+ * @channel : the #XfconfChannel where settings are stored
+ * @prop_name : the name of the property being modified
+ * @value : the updated value of the property being modified
+ * @conf : the #ParoleConf instance
*
* Event handler for when a property is modified.
**/
@@ -335,7 +335,7 @@ static void parole_conf_prop_changed(XfconfChannel *channel,
/**
* parole_conf_finalize:
- * @object : a #ParoleConf instance passed as #GObject.
+ * @object : a #ParoleConf instance passed as #GObject
*
* Finalize a #ParoleConf instance.
**/
@@ -351,8 +351,8 @@ parole_conf_finalize(GObject *object) {
/**
* transform_string_to_boolean:
- * @src : source #GValue string to be transformed.
- * @dst : destination #GValue boolean variable to store the transformed string.
+ * @src : source #GValue string to be transformed
+ * @dst : destination #GValue boolean variable to store the transformed string
*
* Transform a #GValue string into a #GValue boolean.
**/
@@ -363,8 +363,8 @@ transform_string_to_boolean(const GValue *src, GValue *dst) {
/**
* transform_string_to_int:
- * @src : source #GValue string to be transformed.
- * @dst : destination #GValue int variable to store the transformed string.
+ * @src : source #GValue string to be transformed
+ * @dst : destination #GValue int variable to store the transformed string
*
* Transform a #GValue string into a #GValue int.
**/
@@ -375,8 +375,8 @@ transform_string_to_int(const GValue *src, GValue *dst) {
/**
* transform_string_to_enum:
- * @src : source #GValue string to be transformed.
- * @dst : destination #GValue enum variable to store the transformed string.
+ * @src : source #GValue string to be transformed
+ * @dst : destination #GValue enum variable to store the transformed string
*
* Transform a #GValue string into a #GValue enum.
**/
@@ -395,7 +395,7 @@ transform_string_to_enum(const GValue *src, GValue *dst) {
/**
* parole_conf_class_init:
- * @klass : a #ParoleConfClass to initialize.
+ * @klass : a #ParoleConfClass to initialize
*
* Initialize a base #ParoleConfClass instance.
**/
@@ -889,7 +889,7 @@ parole_conf_class_init(ParoleConfClass *klass) {
/**
* parole_conf_load_rc_file:
- * @conf : a #ParoleConf instance.
+ * @conf : a #ParoleConf instance
*
* Load Parole's rc file. Since Parole now uses Xfconf, this will import any
* existing settings into Xfconf and the rc file will no longer be needed.
@@ -968,7 +968,7 @@ parole_conf_load_rc_file(ParoleConf *conf) {
/**
* parole_conf_init:
- * @conf : a #ParoleConf instance.
+ * @conf : a #ParoleConf instance
*
* Initialize a #ParoleConf instance.
**/
@@ -1001,7 +1001,7 @@ parole_conf_init(ParoleConf *conf) {
/**
* parole_conf_new:
*
- * Create a new #ParoleConf instance.
+ * Create a new #ParoleConf instance
**/
ParoleConf *
parole_conf_new(void) {
@@ -1017,8 +1017,8 @@ parole_conf_new(void) {
/**
* parole_conf_get_property_bool:
- * @conf : a #ParoleConf instance.
- * @name : the name of the property being retrieved.
+ * @conf : a #ParoleConf instance
+ * @name : the name of the property being retrieved
*
* Return a boolean value from a property.
**/
@@ -1078,8 +1078,6 @@ parole_conf_read_entry_list(ParoleConf *conf, const gchar *name) {
return ret_val;
}
-
-
void
parole_conf_xfconf_init_failed(void) {
no_xfconf = TRUE;
diff --git a/src/parole-disc.c b/src/parole-disc.c
index 211ecd8..1af0232 100644
--- a/src/parole-disc.c
+++ b/src/parole-disc.c
@@ -81,7 +81,7 @@ typedef struct {
/**
* free_mount_data:
- * @data : pointer to the mount point.
+ * @data : pointer to the mount point
*
* Free the mount-point.
**/
@@ -151,8 +151,8 @@ parole_disc_set_kind(ParoleDisc *disc, ParoleDiscKind kind) {
/**
* parole_disc_media_activate_cb:
- * @widget : the #GtkWidget activated for this callback function.
- * @disc : the #ParoleDisc instance.
+ * @widget : the #GtkWidget activated for this callback function
+ * @disc : the #ParoleDisc instance
*
* Callback function for when the CD/DVD menu item is activated.
**/
@@ -167,9 +167,9 @@ parole_disc_media_activate_cb(GtkWidget *widget, ParoleDisc *disc) {
/**
* parole_disc_show_menu_item:
- * @disc : the #ParoleDisc instance.
- * @data : the #MountData of the inserted disc.
- * @label : the name of the inserted disc.
+ * @disc : the #ParoleDisc instance
+ * @data : the #MountData of the inserted disc
+ * @label : the name of the inserted disc
*
* Show the respective disc-item in the "Media" menu, or "Insert Disc" if no
* disc is detected.
@@ -192,10 +192,10 @@ parole_disc_show_menu_item(ParoleDisc *disc, MountData *data, const gchar *label
/**
* parole_disc_get_mount_data:
- * @disc : the #ParoleDisc instance.
- * @uri : the URI of the mount point.
- * @device : the device identifier of the mount point.
- * @kind : the #ParoleDiscKind representing the type of disc (CD/DVD/SVCD).
+ * @disc : the #ParoleDisc instance
+ * @uri : the URI of the mount point
+ * @device : the device identifier of the mount point
+ * @kind : the #ParoleDiscKind representing the type of disc (CD/DVD/SVCD)
*
* Get data from the mount-point.
**/
@@ -218,9 +218,9 @@ parole_disc_get_mount_data(ParoleDisc *disc,
/**
* parole_disc_add_mount_to_menu:
- * @disc : the #ParoleDisc instance.
- * @mount : the #GMount representing the mounted disc.
- * @device : the device identifier of the mount point.
+ * @disc : the #ParoleDisc instance
+ * @mount : the #GMount representing the mounted disc
+ * @device : the device identifier of the mount point
*
* Add the mounted disc to the "Media" menu.
**/
@@ -296,9 +296,9 @@ got_cdda:
/**
* parole_disc_check_cdrom:
- * @disc : the #ParoleDisc instance.
- * @volume : the #GVolume for the mounted disc.
- * @device : the device identifier of the mount point.
+ * @disc : the #ParoleDisc instance
+ * @volume : the #GVolume for the mounted disc
+ * @device : the device identifier of the mount point
*
* Check the state of the drive.
**/
@@ -346,9 +346,9 @@ out:
/**
* parole_disc_add_drive:
- * @disc : the #ParoleDisc instance.
- * @drive : the #GDrive for the mounted disc.
- * @device : the device identifier of the mount point.
+ * @disc : the #ParoleDisc instance
+ * @drive : the #GDrive for the mounted disc
+ * @device : the device identifier of the mount point
*
* Add the disc drive to the menu.
**/
@@ -385,7 +385,7 @@ parole_disc_add_drive(ParoleDisc *disc, GDrive *drive, const gchar *device) {
/**
* parole_disc_get_drives:
- * @disc : the #ParoleDisc instance.
+ * @disc : the #ParoleDisc instance
*
* Get the list of available drives and attempt to add each to the menu.
**/
@@ -426,8 +426,8 @@ parole_disc_get_drives(ParoleDisc *disc) {
/**
* parole_disc_select_cb:
- * @item : "Media" menu item passed to the callback function.
- * @disc : the #ParoleDisc instance.
+ * @item : "Media" menu item passed to the callback function
+ * @disc : the #ParoleDisc instance
*
* Callback function for selecting the "Media" menu item. If a disc update is
* needed, perform it when the menu item is activated.
@@ -440,9 +440,9 @@ parole_disc_select_cb(GtkMenuItem *item, ParoleDisc *disc) {
/**
* parole_disc_monitor_changed_cb:
- * @monitor : the #GVolumeMonitor that monitors changes to attached volumes.
- * @device : the device identifier of the mount point.
- * @disc : the #ParoleDisc instance.
+ * @monitor : the #GVolumeMonitor that monitors changes to attached volumes
+ * @device : the device identifier of the mount point
+ * @disc : the #ParoleDisc instance
*
* Callback function for when attached volumes are modified. Set the disc item
* to blank and tell the #ParoleDisc to check for updates.
@@ -456,7 +456,7 @@ parole_disc_monitor_changed_cb(GVolumeMonitor *monitor, gpointer *device, Parole
/**
* parole_disc_class_init:
- * @klass : the #ParoleDiscClass to initialize.
+ * @klass : the #ParoleDiscClass to initialize
*
* Initialize the #ParoleDiscClass.
**/
@@ -490,7 +490,7 @@ parole_disc_class_init(ParoleDiscClass *klass) {
/**
* parole_disc_init:
- * @disc : the #ParoleDisc to initialize.
+ * @disc : the #ParoleDisc to initialize
*
* Initialize the disc monitor.
**/
@@ -536,7 +536,7 @@ parole_disc_init(ParoleDisc *disc) {
/**
* parole_disc_finalize:
- * @object : a base #GObject to be made into a #ParoleDisc object.
+ * @object : a base #GObject to be made into a #ParoleDisc object
*
* Finalize a #ParoleDisc object.
**/
diff --git a/src/parole-medialist.c b/src/parole-medialist.c
index f45b04d..66d5dce 100644
--- a/src/parole-medialist.c
+++ b/src/parole-medialist.c
@@ -241,8 +241,8 @@ parole_media_list_get_playlist_count(ParoleMediaList *list) {
* parole_media_list_add:
* @ParoleMediaList: a #ParoleMediaList
* @file: a #ParoleFile
- * @disc: TRUE if added to disc playlist.
- * @emit: TRUE to emit a play signal.
+ * @disc: TRUE if added to disc playlist
+ * @emit: TRUE to emit a play signal
* @select_row: TRUE to select the added row
*
* All the media items added to the media list view are added by
@@ -332,8 +332,8 @@ parole_media_list_add(ParoleMediaList *list, ParoleFile *file, gboolean disc, gb
* parole_media_list_files_open:
* @ParoleMediaList: a #ParoleMediaList
* @files: a #GSList contains a list of #ParoleFile
- * @disc: TRUE if files are opened to the disc playlist.
- * @emit: TRUE to emit a play signal.
+ * @disc: TRUE if files are opened to the disc playlist
+ * @emit: TRUE to emit a play signal
*
**/
static void
@@ -859,7 +859,7 @@ parole_media_list_get_first_path(GtkTreeModel *model) {
*
* Converts a list of #GtkTreePath to a list of #GtkTreeRowReference
*
- * Returns: a #GList contains a list of #GtkTreeRowReference.
+ * Returns: a #GList contains a list of #GtkTreeRowReference
*
*
**/
@@ -1770,7 +1770,7 @@ gboolean parole_media_list_is_empty(ParoleMediaList *list) {
* @list: a #ParoleMediaList
*
*
- * Returns: a #GtkTreeRowReference of the first row in the media list.
+ * Returns: a #GtkTreeRowReference of the first row in the media list
**/
GtkTreeRowReference *parole_media_list_get_first_row(ParoleMediaList *list) {
GtkTreeRowReference *row = NULL;
@@ -1792,7 +1792,7 @@ GtkTreeRowReference *parole_media_list_get_first_row(ParoleMediaList *list) {
* @list: a #ParoleMediaList
*
*
- * Returns: a #GtkTreeRowReference of the selected row.
+ * Returns: a #GtkTreeRowReference of the selected row
**/
GtkTreeRowReference *parole_media_list_get_selected_row(ParoleMediaList *list) {
return parole_media_list_get_first_selected_row (list);
@@ -1803,7 +1803,7 @@ GtkTreeRowReference *parole_media_list_get_selected_row(ParoleMediaList *list) {
* @list: a #ParoleMediaList
*
*
- * Returns: a #ParoleFile of the selected row.
+ * Returns: a #ParoleFile of the selected row
**/
ParoleFile *parole_media_list_get_selected_file(ParoleMediaList *list) {
return parole_media_list_get_first_selected_file (list);
diff --git a/src/parole-module.c b/src/parole-module.c
index 0b2feaf..c55941f 100644
--- a/src/parole-module.c
+++ b/src/parole-module.c
@@ -192,7 +192,7 @@ parole_provider_module_new(const gchar *filename, const gchar *desktop_file, con
/**
* parole_provider_module_new_plugin:
- * @module : The #ParoleProviderModule that is being initialized.
+ * @module : The #ParoleProviderModule that is being initialized
*
* Initialize the #ParoleProviderModule plugin. Return #TRUE if successful.
**/
diff --git a/src/parole-player.c b/src/parole-player.c
index 5b78f09..c0b9dc0 100644
--- a/src/parole-player.c
+++ b/src/parole-player.c
@@ -944,8 +944,8 @@ parole_player_show_audiobox(ParolePlayer *player) {
/**
* parole_player_select_custom_subtitle:
- * @widget : The #GtkMenuItem for selecting a custom subtitle file.
- * @data : The #ParolePlayer instance passed by the callback function.
+ * @widget : The #GtkMenuItem for selecting a custom subtitle file
+ * @data : The #ParolePlayer instance passed by the callback function
*
* Display the #FileChooserDialog for selecting a custom subtitle file and load
* the subtitles selected.
@@ -1947,8 +1947,8 @@ parole_player_window_state_event(GtkWidget *widget,
/**
* parole_player_reset_controls:
- * @player : the #ParolePlayer instance.
- * @fullscreen : %TRUE if player should be fullscreen, else %FALSE.
+ * @player : the #ParolePlayer instance
+ * @fullscreen : %TRUE if player should be fullscreen, else %FALSE
*
* Reset the player controls based on existing conditions.
**/
diff --git a/src/plugins/sample/sample-provider.c b/src/plugins/sample/sample-provider.c
index 5bbcf7e..42bf412 100644
--- a/src/plugins/sample/sample-provider.c
+++ b/src/plugins/sample/sample-provider.c
@@ -27,7 +27,7 @@
#include "src/plugins/sample/sample-provider.h"
static void sample_provider_iface_init(ParoleProviderPluginIface *iface);
-static void sample_provider_finalize(GObject *object);
+static void sample_provider_finalize(GObject *object);
struct _SampleProviderClass {
@@ -40,10 +40,10 @@ struct _SampleProvider {
};
PAROLE_DEFINE_TYPE_WITH_CODE(SampleProvider,
- sample_provider,
- G_TYPE_OBJECT,
- PAROLE_IMPLEMENT_INTERFACE(PAROLE_TYPE_PROVIDER_PLUGIN,
- sample_provider_iface_init));
+ sample_provider,
+ G_TYPE_OBJECT,
+ PAROLE_IMPLEMENT_INTERFACE(PAROLE_TYPE_PROVIDER_PLUGIN,
+ sample_provider_iface_init));
static gboolean sample_provider_is_configurable(ParoleProviderPlugin *plugin) {
return FALSE;
diff --git a/src/plugins/sample/sample-provider.h b/src/plugins/sample/sample-provider.h
index 1da7533..ea33447 100644
--- a/src/plugins/sample/sample-provider.h
+++ b/src/plugins/sample/sample-provider.h
@@ -37,9 +37,9 @@ typedef struct _SampleProvider SampleProvider;
#define SAMPLE_IS_PROVIDER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SAMPLE_TYPE_PROVIDER))
#define SAMPLE_PROVIDER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), SAMPLE_TYPE_PROVIDER, SampleProviderClass))
-GType sample_provider_get_type (void) G_GNUC_CONST G_GNUC_INTERNAL;
+GType sample_provider_get_type (void) G_GNUC_CONST G_GNUC_INTERNAL;
-void sample_provider_register_type (ParoleProviderPlugin *plugin);
+void sample_provider_register_type (ParoleProviderPlugin *plugin);
G_END_DECLS
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the Xfce4-commits
mailing list