GNOME.org
 

[rhythmbox] fix more gtk-doc issues

commit 46e21a635bd54da213ac806e90a4a35e28bcb14e
Author: Jonathan Matthew <jonathan d14n org>
Date:   Sat Mar 20 19:58:18 2010 +1000

    fix more gtk-doc issues

 backends/rb-player.c                 |   22 +++++++---
 doc/reference/Makefile.am            |    1 +
 doc/reference/rhythmbox-sections.txt |    1 -
 metadata/rb-metadata-common.c        |    8 +++-
 metadata/rb-metadata-dbus-client.c   |    2 +
 shell/rb-play-order.c                |   20 +++++++--
 shell/rb-playlist-manager.c          |    4 +-
 sources/rb-playlist-source.c         |    4 +-
 sources/rb-source-group.c            |   16 ++++++--
 sources/rb-source.c                  |   72 +++++++++++++++++++++++++---------
 widgets/rb-entry-view.c              |   52 ++++++++++++++----------
 widgets/rb-header.c                  |    2 +
 widgets/rb-header.h                  |    2 -
 widgets/rb-library-browser.c         |   14 +++++-
 widgets/rb-property-view.c           |   12 ++++-
 widgets/rb-query-creator.c           |    2 +
 widgets/rb-rating.c                  |    2 +
 17 files changed, 167 insertions(+), 69 deletions(-)
---
diff --git a/backends/rb-player.c b/backends/rb-player.c
index ecd3fa5..26c8dc2 100644
--- a/backends/rb-player.c
+++ b/backends/rb-player.c
@@ -328,6 +328,8 @@ rb_player_open (RBPlayer *player, const char *uri, gpointer stream_data, GDestro
  * rb_player_opened:
  * @player: 	a #RBPlayer
  *
+ * Determines whether a stream has been prepared for playback.
+ *
  * Return value: TRUE if a stream is prepared for playback
  */
 gboolean
@@ -417,8 +419,10 @@ rb_player_pause (RBPlayer *player)
  * rb_player_playing:
  * @player:	a #RBPlayer.
  *
- * Return value: TRUE if a stream is currently being played (not paused
- *  or being faded out).
+ * Determines whether the player is currently playing a stream.
+ * A stream is playing if it's not paused or being faded out.
+ *
+ * Return value: TRUE if playing
  */
 gboolean
 rb_player_playing (RBPlayer *player)
@@ -449,6 +453,8 @@ rb_player_set_volume (RBPlayer *player, float volume)
  * rb_player_get_volume:
  * @player:	a #RBPlayer
  *
+ * Returns the current volume level, between 0.0 and 1.0.
+ *
  * Return value: current output volume level
  */
 float
@@ -463,6 +469,8 @@ rb_player_get_volume (RBPlayer *player)
  * rb_player_seekable:
  * @player:	a #RBPlayer
  *
+ * Determines whether seeking is supported for the current stream.
+ *
  * Return value: TRUE if the current stream is seekable
  */
 gboolean
@@ -494,8 +502,9 @@ rb_player_set_time (RBPlayer *player, gint64 newtime)
  * rb_player_get_time:
  * @player:	a #RBPlayer
  *
- * Return value: the current playback position in the current stream
- *  in nanoseconds.
+ * Returns the current playback for the current stream in nanoseconds.
+ *
+ * Return value: playback position
  */
 gint64
 rb_player_get_time (RBPlayer *player)
@@ -509,8 +518,9 @@ rb_player_get_time (RBPlayer *player)
  * rb_player_multiple_open:
  * @player:	a #RBPlayer
  *
- * Return value: TRUE if the player supports multiple open streams
- * 		(not necessarily multiple playing streams, though)
+ * Determines whether the player supports multiple open streams.
+ *
+ * Return value: TRUE if multiple open is supported
  */
 gboolean
 rb_player_multiple_open (RBPlayer *player)
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 9251ec8..de8ee9f 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -53,6 +53,7 @@ IGNORE_HFILES= \
 	\
 	gedit-message-area.h \
 	gossip-cell-renderer-expander.h \
+	rb-query-creator-private.h \
 	\
 	sj-error.h \
 	sj-metadata-getter.h \
diff --git a/doc/reference/rhythmbox-sections.txt b/doc/reference/rhythmbox-sections.txt
index 1d4e6cb..a933e67 100644
--- a/doc/reference/rhythmbox-sections.txt
+++ b/doc/reference/rhythmbox-sections.txt
@@ -959,7 +959,6 @@ rb_header_new
 rb_header_set_show_position_slider
 rb_header_sync
 rb_header_sync_time
-rb_header_get_elapsed_string
 <SUBSECTION Standard>
 RBHeaderPrivate
 RB_HEADER
diff --git a/metadata/rb-metadata-common.c b/metadata/rb-metadata-common.c
index 1d6e2f5..7f4ec81 100644
--- a/metadata/rb-metadata-common.c
+++ b/metadata/rb-metadata-common.c
@@ -73,7 +73,9 @@
  * rb_metadata_get_field_type:
  * @field: a #RBMetaDataField
  *
- * Return value: the #GType of the value for the metadata field
+ * Returns the #GType of the value for a metadata field.
+ *
+ * Return value: value type
  */
 GType
 rb_metadata_get_field_type (RBMetaDataField field)
@@ -126,7 +128,9 @@ rb_metadata_get_field_type (RBMetaDataField field)
  * rb_metadata_get_field_name:
  * @field: a #RBMetaDataField
  *
- * Return value: the name of the metadata field
+ * Returns the name of a metadata field.
+ *
+ * Return value: field name
  */
 const char *
 rb_metadata_get_field_name (RBMetaDataField field)
diff --git a/metadata/rb-metadata-dbus-client.c b/metadata/rb-metadata-dbus-client.c
index ae29a83..9009bb3 100644
--- a/metadata/rb-metadata-dbus-client.c
+++ b/metadata/rb-metadata-dbus-client.c
@@ -133,6 +133,8 @@ rb_metadata_finalize (GObject *object)
 /**
  * rb_metadata_new:
  *
+ * Creates a new metadata backend instance.
+ *
  * Return value: new #RBMetaData instance
  */
 RBMetaData *
diff --git a/shell/rb-play-order.c b/shell/rb-play-order.c
index 6c15432..a4192de 100644
--- a/shell/rb-play-order.c
+++ b/shell/rb-play-order.c
@@ -377,7 +377,9 @@ rb_play_order_get_query_model (RBPlayOrder *porder)
  * rb_play_order_player_is_playing:
  * @porder: #RBPlayOrder instance
  *
- * Returns: true if there is a current playing entry in the play order.
+ * Returns %TRUE if there is a current playing entry in the play order.
+ *
+ * Return value: %TRUE if playing
  **/
 gboolean
 rb_play_order_player_is_playing (RBPlayOrder *porder)
@@ -407,7 +409,9 @@ rb_play_order_set_playing_entry (RBPlayOrder *porder,
  * rb_play_order_get_playing_entry:
  * @porder: #RBPlayOrder instance
  *
- * Returns: the current playing entry in the play order.
+ * Returns the current playing entry in the play order.
+ *
+ * Returns: playing entry
  */
 RhythmDBEntry *
 rb_play_order_get_playing_entry (RBPlayOrder *porder)
@@ -746,7 +750,9 @@ rb_play_order_has_next (RBPlayOrder *porder)
  * rb_play_order_get_next:
  * @porder: RBPlayOrder instance
  *
- * Returns: the next entry in the play order, or the first if not currently playing.
+ * Returns the next entry in the play order, or the first if not currently playing.
+ *
+ * Returns: next entry to play
  */
 RhythmDBEntry *
 rb_play_order_get_next (RBPlayOrder *porder)
@@ -802,7 +808,9 @@ rb_play_order_has_previous (RBPlayOrder *porder)
  * rb_play_order_get_previous:
  * @porder: RBPlayOrder instance
  *
- * Returns: the previous entry in the play order, or NULL if not currently playing.
+ * Returns the previous entry in the play order, or NULL if not currently playing.
+ *
+ * Return value: previous entry
  */
 RhythmDBEntry *
 rb_play_order_get_previous (RBPlayOrder *porder)
@@ -841,9 +849,11 @@ rb_play_order_go_previous (RBPlayOrder *porder)
  * rb_play_order_model_not_empty:
  * @porder: RBPlayOrder instance
  *
- * Returns: true if the #RhythmDBQueryModel is not empty.
+ * Returns %TRUE if the #RhythmDBQueryModel is not empty.
  * Can be used to implement has_next and has_previous for play orders
  * that have no beginning or end.
+ *
+ * Return value: %TRUE if not empty
  */
 gboolean
 rb_play_order_model_not_empty (RBPlayOrder *porder)
diff --git a/shell/rb-playlist-manager.c b/shell/rb-playlist-manager.c
index be41742..adc079e 100644
--- a/shell/rb-playlist-manager.c
+++ b/shell/rb-playlist-manager.c
@@ -1641,7 +1641,9 @@ list_playlists_cb (GtkTreeModel *model,
  * rb_playlist_manager_get_playlists
  * @mgr: the #RBPlaylistManager
  *
- * Return value: a #GList containing all local playlist source objects.
+ * Returns a #GList containing all local playlist source objects.
+ *
+ * Return value: list of playlists
  **/
 GList *
 rb_playlist_manager_get_playlists (RBPlaylistManager *mgr)
diff --git a/sources/rb-playlist-source.c b/sources/rb-playlist-source.c
index 60ad9d2..82d0df4 100644
--- a/sources/rb-playlist-source.c
+++ b/sources/rb-playlist-source.c
@@ -1064,7 +1064,9 @@ rb_playlist_source_mark_dirty (RBPlaylistSource *source)
  * @source: a #RBPlaylistSource
  * @location: a URI to check
  *
- * Return value: TRUE if the specified URI is in the playlist entry map
+ * Returns TRUE if the specified URI is in the playlist entry map
+ *
+ * Return value: %TRUE if the URI is present
  */
 gboolean
 rb_playlist_source_location_in_map (RBPlaylistSource *source,
diff --git a/sources/rb-source-group.c b/sources/rb-source-group.c
index ce5f833..abbe707 100644
--- a/sources/rb-source-group.c
+++ b/sources/rb-source-group.c
@@ -202,7 +202,9 @@ rb_source_group_library_get_type (void)
 /**
  * rb_source_group_playlists_get_type:
  *
- * Return value: the predefined playlists source group
+ * Returns the predefined playlists source group
+ *
+ * Return value: playlists source group
  */
 RBSourceGroup *
 rb_source_group_playlists_get_type (void)
@@ -213,7 +215,9 @@ rb_source_group_playlists_get_type (void)
 /**
  * rb_source_group_devices_get_type:
  *
- * Return value: the predefined devices source group
+ * Returns the predefined devices source group
+ *
+ * Return value: devices source group
  */
 RBSourceGroup *
 rb_source_group_devices_get_type (void)
@@ -224,7 +228,9 @@ rb_source_group_devices_get_type (void)
 /**
  * rb_source_group_shared_get_type:
  *
- * Return value: the predefined shared source group
+ * Returns the predefined shared source group
+ *
+ * Return value: shared source group
  */
 RBSourceGroup *
 rb_source_group_shared_get_type (void)
@@ -235,7 +241,9 @@ rb_source_group_shared_get_type (void)
 /**
  * rb_source_group_stores_get_type:
  *
- * Return value: the predefined stores source group
+ * Returns the predefined stores source group
+ *
+ * Return value: stores source group
  */
 RBSourceGroup *
 rb_source_group_stores_get_type (void)
diff --git a/sources/rb-source.c b/sources/rb-source.c
index be03da8..5cc3c89 100644
--- a/sources/rb-source.c
+++ b/sources/rb-source.c
@@ -543,8 +543,10 @@ queue_update_visibility (RBSource *source)
 /**
  * rb_source_set_hidden_when_empty:
  * @source: a #RBSource
- * @hidden: if TRUE, the source should not be displayed in
- *   the source list when there are no entries in it
+ * @hidden: if TRUE, automatically hide the source
+ *
+ * Enables or disables automatic hiding of the source when
+ * there are no entries in it.
  */
 void
 rb_source_set_hidden_when_empty (RBSource *source,
@@ -763,8 +765,9 @@ default_get_browser_key (RBSource *source)
  * rb_source_get_browser_key:
  * @source: a #RBSource
  *
- * Return value: the GConf key that determines browser visibility
- * for this source (allocated)
+ * Gets the GConf key controlling browser visibility
+ *
+ * Return value: the GConf key name (allocated)
  */
 char *
 rb_source_get_browser_key (RBSource *source)
@@ -778,6 +781,8 @@ rb_source_get_browser_key (RBSource *source)
  * rb_source_can_browse:
  * @source: a #RBSource
  *
+ * Determines whether the source has a browser
+ *
  * Return value: TRUE if this source has a browser
  */
 gboolean
@@ -874,6 +879,8 @@ rb_source_update_play_statistics (RBSource *source,
  * rb_source_get_entry_view:
  * @source: a #RBSource
  *
+ * Returns the entry view widget for the source.
+ *
  * Return value: the #RBEntryView instance for the source
  */
 RBEntryView *
@@ -894,8 +901,10 @@ default_get_property_views (RBSource *source)
  * rb_source_get_property_views:
  * @source: a #RBSource
  *
- * Return value:  a list containing the #RBPropertyView<!-- -->s that
- * make up the browser for this source, if any.
+ * Returns a list containing the #RBPropertyView instances for the
+ * source, if any.
+ *
+ * Return value:  list of property views
  */
 GList *
 rb_source_get_property_views (RBSource *source)
@@ -915,6 +924,8 @@ default_can_rename (RBSource *source)
  * rb_source_can_rename:
  * @source: a #RBSource.
  *
+ * Determines whether the source can be renamed.
+ *
  * Return value: TRUE if this source can be renamed
  */
 gboolean
@@ -982,8 +993,10 @@ rb_source_get_config_widget (RBSource *source,
  * rb_source_can_cut:
  * @source: a #RBSource
  *
- * Return value: TRUE if the source supports the typical cut
+ * Determines whether the source supporst the typical cut
  * (as in cut-and-paste) operation.
+ *
+ * Return value: TRUE if cutting is supported
  */
 gboolean
 rb_source_can_cut (RBSource *source)
@@ -997,8 +1010,9 @@ rb_source_can_cut (RBSource *source)
  * rb_source_can_paste:
  * @source: a #RBSource
  *
- * Return value: TRUE if the source supports the typical paste
- * (as in cut-and-paste) operation.
+ * Determines whether the source supports paste operations.
+ *
+ * Return value: TRUE if the pasting is supported
  */
 gboolean
 rb_source_can_paste (RBSource *source)
@@ -1012,8 +1026,10 @@ rb_source_can_paste (RBSource *source)
  * rb_source_can_delete:
  * @source: a #RBSource
  *
- * Return value: TRUE if the source allows the user to delete
+ * Determines whether the source allows the user to delete
  * a selected set of entries.
+ *
+ * Return value: TRUE if deletion is supported
  */
 gboolean
 rb_source_can_delete (RBSource *source)
@@ -1032,8 +1048,10 @@ rb_source_can_delete (RBSource *source)
  * rb_source_can_move_to_trash:
  * @source: a #RBSource
  *
- * Return value: TRUE if the source allows the user to trash
+ * Determines whether the source allows the user to trash
  * the files backing a selected set of entries.
+ *
+ * Return value: TRUE if trashing is supported
  */
 gboolean
 rb_source_can_move_to_trash (RBSource *source)
@@ -1052,8 +1070,10 @@ rb_source_can_move_to_trash (RBSource *source)
  * rb_source_can_copy:
  * @source: a #RBSource
  *
- * Return value: TRUE if the source supports the copy part
+ * Determines whether the source supports the copy part
  * of a copy-and-paste operation.
+ *
+ * Return value: TRUE if copying is supported
  */
 gboolean
 rb_source_can_copy (RBSource *source)
@@ -1096,6 +1116,8 @@ default_copy (RBSource *source)
  * rb_source_copy:
  * @source: a #RBSource
  *
+ * Copies the selected entries to the clipboard.
+ *
  * Return value: a list containing the currently selected entries from
  * the source.
  */
@@ -1127,8 +1149,10 @@ rb_source_paste (RBSource *source, GList *entries)
  * rb_source_can_add_to_queue:
  * @source: a #RBSource
  *
- * Return value: TRUE if this source can add the current selected
- * set of entries to the play queue
+ * Determines whether the source can add the selected entries to
+ * the play queue.
+ *
+ * Return value: TRUE if adding to the play queue is supported
  */
 gboolean
 rb_source_can_add_to_queue (RBSource *source)
@@ -1258,8 +1282,10 @@ rb_source_reset_filters (RBSource *source)
  * rb_source_can_show_properties:
  * @source: a #RBSource
  *
- * Return value: TRUE if the source can display a properties
+ * Determines whether the source can display a properties
  * window for the currently selected entry (or set of entries)
+ *
+ * Return value: TRUE if showing properties is supported
  */
 gboolean
 rb_source_can_show_properties (RBSource *source)
@@ -1288,8 +1314,10 @@ rb_source_song_properties (RBSource *source)
  * rb_source_try_playlist:
  * @source: a #RBSource
  *
- * Return value: TRUE if the playback URIs for entries in the source
- *  should be parsed as playlists, rather than just played.
+ * Determines whether playback URIs for entries in the source should
+ * be parsed as playlists rather than just played.
+ *
+ * Return value: TRUE to attempt playlist parsing
  */
 gboolean
 rb_source_try_playlist (RBSource *source)
@@ -1366,7 +1394,10 @@ rb_source_add_uri (RBSource *source, const char *uri, const char *title, const c
  * rb_source_can_pause:
  * @source: a #RBSource
  *
- * Return value: TRUE if playback of entries from the source can be paused.
+ * Determines whether playback of entries from the source can
+ * be paused.
+ *
+ * Return value: TRUE if pausing is supported
  */
 gboolean
 rb_source_can_pause (RBSource *source)
@@ -1392,7 +1423,10 @@ default_handle_eos (RBSource *source)
  * rb_source_handle_eos:
  * @source: a #RBSource
  *
- * Return value: how EOS events should be handled for entries from this source
+ * Determines how EOS events should be handled when playing entries
+ * from the source.
+ *
+ * Return value: EOS event handling type
  */
 RBSourceEOFType
 rb_source_handle_eos (RBSource *source)
diff --git a/widgets/rb-entry-view.c b/widgets/rb-entry-view.c
index 0210372..ba59640 100644
--- a/widgets/rb-entry-view.c
+++ b/widgets/rb-entry-view.c
@@ -54,6 +54,21 @@
 
 /**
  * RBEntryViewColumn:
+ * @RB_ENTRY_VIEW_COL_TRACK_NUMBER: the track number column
+ * @RB_ENTRY_VIEW_COL_TITLE: the title column
+ * @RB_ENTRY_VIEW_COL_ARTIST: the artist column
+ * @RB_ENTRY_VIEW_COL_ALBUM: the album column
+ * @RB_ENTRY_VIEW_COL_GENRE: the genre column
+ * @RB_ENTRY_VIEW_COL_DURATION: the duration column
+ * @RB_ENTRY_VIEW_COL_QUALITY: the quality (bitrate) column
+ * @RB_ENTRY_VIEW_COL_RATING: the rating column
+ * @RB_ENTRY_VIEW_COL_PLAY_COUNT: the play count column
+ * @RB_ENTRY_VIEW_COL_YEAR: the year (release date) column
+ * @RB_ENTRY_VIEW_COL_LAST_PLAYED: the last played time column
+ * @RB_ENTRY_VIEW_COL_FIRST_SEEN: the first seen (imported) column
+ * @RB_ENTRY_VIEW_COL_LAST_SEEN: the last seen column
+ * @RB_ENTRY_VIEW_COL_LOCATION: the location column
+ * @RB_ENTRY_VIEW_COL_ERROR: the error column
  *
  * Predefined column types to use in #RBEntryView<!-- -->s.  Use
  * #rb_entry_view_append_column to add these to an entry view.
@@ -1995,8 +2010,10 @@ harvest_entries (GtkTreeModel *model,
  * rb_entry_view_get_selected_entries:
  * @view: a #RBEntryView
  *
- * Return value: a #GList containing the currently selected entries in the view
- *  (must be freed)
+ * Gathers the selected entries from the view.
+ *
+ * Return value: a #GList of selected entries in the view
+ *  (must be freed and the entries unreffed)
  */
 GList *
 rb_entry_view_get_selected_entries (RBEntryView *view)
@@ -2092,7 +2109,9 @@ rb_entry_view_selection_changed_cb (GtkTreeSelection *selection,
  * rb_entry_view_have_selection:
  * @view: a #RBEntryView
  *
- * Return value: TRUE if one or more rows are selected in the view
+ * Determines whether there is an active selection in the view.
+ *
+ * Return value: TRUE if one or more rows are selected
  */
 gboolean
 rb_entry_view_have_selection (RBEntryView *view)
@@ -2104,6 +2123,8 @@ rb_entry_view_have_selection (RBEntryView *view)
  * rb_entry_view_have_complete_selection:
  * @view: a #RBEntryView
  *
+ * Determines whether all entries in the view are selected.
+ *
  * Return value: TRUE if all rows in the view are selected
  */
 gboolean
@@ -2307,7 +2328,10 @@ rb_entry_view_scroll_to_iter (RBEntryView *view,
  * @view: a #RBEntryView
  * @entry: a #RhythmDBEntry to check
  *
- * Return value: TRUE if the entry is present in the view and is currently visible
+ * Determines whether a specified entry is present in the view
+ * and is currently visible.
+ *
+ * Return value: TRUE if the entry is visible
  */
 gboolean
 rb_entry_view_get_entry_visible (RBEntryView *view,
@@ -2329,6 +2353,8 @@ rb_entry_view_get_entry_visible (RBEntryView *view,
  * @view: a #RBEntryView
  * @entry: a #RhythmDBEntry to check
  *
+ * Determines whether a specified entry is present in the view.
+ *
  * Return value: TRUE if the entry is present in the view
  */
 gboolean
@@ -2677,21 +2703,3 @@ rb_entry_view_state_get_type (void)
 
 	return etype;
 }
-
-/**
- * RBEntryViewColumn:
- * @RB_ENTRY_VIEW_COL_TRACK_NUMBER: the track number column
- * @RB_ENTRY_VIEW_COL_TITLE: the title column
- * @RB_ENTRY_VIEW_COL_ARTIST: the artist column
- * @RB_ENTRY_VIEW_COL_ALBUM: the album column
- * @RB_ENTRY_VIEW_COL_GENRE: the genre column
- * @RB_ENTRY_VIEW_COL_DURATION: the duration column
- * @RB_ENTRY_VIEW_COL_QUALITY: the quality (bitrate) column
- * @RB_ENTRY_VIEW_COL_RATING: the rating column
- * @RB_ENTRY_VIEW_COL_YEAR: the year (release date) column
- * @RB_ENTRY_VIEW_COL_LAST_PLAYED: the last played time column
- * @RB_ENTRY_VIEW_COL_FIRST_SEEN: the first seen (imported) column
- * @RB_ENTRY_VIEW_COL_LAST_SEEN: the last seen column
- * @RB_ENTRY_VIEW_COL_LOCATION: the location column
- * @RB_ENTRY_VIEW_COL_ERROR: the error column
- */
diff --git a/widgets/rb-header.c b/widgets/rb-header.c
index 6a252f9..c2e4a6a 100644
--- a/widgets/rb-header.c
+++ b/widgets/rb-header.c
@@ -379,6 +379,8 @@ rb_header_get_property (GObject *object,
  * @shell_player: the #RBShellPlayer instance
  * @db: the #RhythmDB instance
  *
+ * Creates a new header widget.
+ *
  * Return value: the header widget
  */
 RBHeader *
diff --git a/widgets/rb-header.h b/widgets/rb-header.h
index b82d5a7..1dfb246 100644
--- a/widgets/rb-header.h
+++ b/widgets/rb-header.h
@@ -72,8 +72,6 @@ void		rb_header_sync			(RBHeader *header);
 
 void		rb_header_sync_time		(RBHeader *header);
 
-char *		rb_header_get_elapsed_string	(RBHeader *header);
-
 G_END_DECLS
 
 #endif /* __RB_HEADER_H */
diff --git a/widgets/rb-library-browser.c b/widgets/rb-library-browser.c
index 8786865..68c02fe 100644
--- a/widgets/rb-library-browser.c
+++ b/widgets/rb-library-browser.c
@@ -375,6 +375,8 @@ rb_library_browser_get_property (GObject *object,
  * @db: the #RhythmDB instance
  * @entry_type: the entry type to use in the browser
  *
+ * Creates a new library browser.
+ *
  * Return value: a new RBLibraryBrowser
  */
 RBLibraryBrowser *
@@ -537,6 +539,8 @@ rb_library_browser_construct_query (RBLibraryBrowser *widget)
  * rb_library_browser_has_selection:
  * @widget: a #RBLibraryBrowser
  *
+ * Determines whether the browser has an active selection.
+ *
  * Return value: TRUE if any items in the browser are selected.
  */
 gboolean
@@ -808,7 +812,9 @@ rb_library_browser_set_selection (RBLibraryBrowser *widget,
  * rb_library_browser_get_property_views:
  * @widget: a #RBLibraryBrowser
  *
- * Return value: a GList containing the #RBPropertyView<!-- -->s
+ * Retrieves the property view widgets from the browser.
+ *
+ * Return value: a GList containing the #RBPropertyView widgets
  *  in the browser.
  */
 GList*
@@ -824,8 +830,10 @@ rb_library_browser_get_property_views (RBLibraryBrowser *widget)
  * @widget: a #RBLibraryBrowser
  * @type: the property
  *
- * Return value: the #RBPropertyView for the specified property, or
- *  NULL if there isn't one
+ * Retrieves the property view widget for the specified property,
+ * if there is one.
+ *
+ * Return value: #RBPropertyView widget, or NULL
  */
 RBPropertyView *
 rb_library_browser_get_property_view (RBLibraryBrowser *widget,
diff --git a/widgets/rb-property-view.c b/widgets/rb-property-view.c
index 30966c0..9bdcde6 100644
--- a/widgets/rb-property-view.c
+++ b/widgets/rb-property-view.c
@@ -521,7 +521,9 @@ rb_property_view_reset (RBPropertyView *view)
  * rb_property_view_get_model:
  * @view: a #RBPropertyView
  * 
- * Return value: the #RhythmDBPropertyModel backing the view; no reference is taken
+ * Returns the #RhythmDBPropertyModel backing the view; no reference is taken
+ *
+ * Return value: property model
  */
 RhythmDBPropertyModel *
 rb_property_view_get_model (RBPropertyView *view)
@@ -586,7 +588,9 @@ rb_property_view_post_row_deleted_cb (GtkTreeModel *model,
  * rb_property_view_get_num_properties
  * @view: a #RBPropertyView
  *
- * Return value: the number of property values present in the view
+ * Returns the number of property values present in the view.
+ *
+ * Return value: number of properties
  */
 guint
 rb_property_view_get_num_properties (RBPropertyView *view)
@@ -778,8 +782,10 @@ rb_property_view_set_selection (RBPropertyView *view,
  * rb_property_view_get_selection:
  * @view: a #RBPropertyView
  *
- * Return value: a #GList containing the selected property values.  The list must
+ * Returns a #GList containing the selected property values.  The list must
  * be freed by the caller.
+ *
+ * Return value: list of selected values
  */
 GList *
 rb_property_view_get_selection (RBPropertyView *view)
diff --git a/widgets/rb-query-creator.c b/widgets/rb-query-creator.c
index f0301d6..d631c39 100644
--- a/widgets/rb-query-creator.c
+++ b/widgets/rb-query-creator.c
@@ -339,6 +339,8 @@ rb_query_creator_get_property (GObject *object,
  * rb_query_creator_new:
  * @db: the #RhythmDB instance
  *
+ * Creates a new query creator widget.
+ *
  * Return value: new query creator widget
  */
 GtkWidget *
diff --git a/widgets/rb-rating.c b/widgets/rb-rating.c
index a1fb2ef..4fadcf7 100644
--- a/widgets/rb-rating.c
+++ b/widgets/rb-rating.c
@@ -269,6 +269,8 @@ rb_rating_set_property (GObject *object,
 /**
  * rb_rating_new:
  *
+ * Creates a new rating widget
+ *
  * Return value: a new #RBRating widget.
  */
 RBRating *
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]