rhythmbox r5682 - in trunk: . doc/reference shell

[jmatthew svn gnome org]

Author: jmatthew
Date: Wed Apr 23 10:50:29 2008
New Revision: 5682
URL: http://svn.gnome.org/viewvc/rhythmbox?rev=5682&view=rev

Log:
2008-04-23  Jonathan Matthew  <jonathan d14n org>

	* doc/reference/rhythmbox-docs.sgml:
	* doc/reference/rhythmbox-sections.txt:
	* shell/rb-play-order-random.c:
	* shell/rb-play-order-random.h:
	gtk-doc for RBPlayOrderRandom


Modified:
   trunk/ChangeLog
   trunk/doc/reference/rhythmbox-docs.sgml
   trunk/doc/reference/rhythmbox-sections.txt
   trunk/shell/rb-play-order-random.c
   trunk/shell/rb-play-order-random.h

Modified: trunk/doc/reference/rhythmbox-docs.sgml
==============================================================================
--- trunk/doc/reference/rhythmbox-docs.sgml	(original)
+++ trunk/doc/reference/rhythmbox-docs.sgml	Wed Apr 23 10:50:29 2008
@@ -47,6 +47,7 @@
 		<title>Shell</title>
 		<xi:include href="xml/rb-history.xml"/>
 		<xi:include href="xml/rb-play-order.xml"/>
+		<xi:include href="xml/rb-play-order-random.xml"/>
 		<xi:include href="xml/rb-playlist-manager.xml"/>
 		<xi:include href="xml/rb-removable-media-manager.xml"/>
 		<xi:include href="xml/rb-shell-clipboard.xml"/>

Modified: trunk/doc/reference/rhythmbox-sections.txt
==============================================================================
--- trunk/doc/reference/rhythmbox-sections.txt	(original)
+++ trunk/doc/reference/rhythmbox-sections.txt	Wed Apr 23 10:50:29 2008
@@ -248,7 +248,9 @@
 
 <SECTION>
 <FILE>rb-play-order-random</FILE>
-RBRandomPlayOrderPrivate
+<TITLE>RBRandomPlayOrder</TITLE>
+RBRandomPlayOrder
+RBRandomPlayOrderClass
 <SUBSECTION Standard>
 RB_RANDOM_PLAY_ORDER
 RB_IS_RANDOM_PLAY_ORDER
@@ -257,6 +259,7 @@
 RB_RANDOM_PLAY_ORDER_CLASS
 RB_IS_RANDOM_PLAY_ORDER_CLASS
 RB_RANDOM_PLAY_ORDER_GET_CLASS
+RBRandomPlayOrderPrivate
 </SECTION>
 
 <SECTION>
@@ -336,7 +339,9 @@
 
 <SECTION>
 <FILE>rb-play-order</FILE>
-RBPlayOrderPrivate
+<TITLE>RBPlayOrder</TITLE>
+RBPlayOrder
+RBPlayOrderClass
 rb_play_order_new
 RBPlayOrderDescription
 rb_play_order_playing_source_changed
@@ -354,10 +359,6 @@
 rb_play_order_get_db
 rb_play_order_get_query_model
 rb_play_order_model_not_empty
-rb_play_order_have_next_changed
-rb_play_order_have_previous_changed
-rb_play_order_player_is_playing
-rb_play_order_check_if_empty
 <SUBSECTION Standard>
 RB_PLAY_ORDER
 RB_IS_PLAY_ORDER

Modified: trunk/shell/rb-play-order-random.c
==============================================================================
--- trunk/shell/rb-play-order-random.c	(original)
+++ trunk/shell/rb-play-order-random.c	Wed Apr 23 10:50:29 2008
@@ -28,9 +28,12 @@
  *
  */
 
-/* This class is a base case for weighted random play orders. Subclasses only
- * need to override get_entry_weight() to return the right weight for a given
- * entry.
+/**
+ * SECTION:rb-play-order-random
+ * @short_description: base class for weighted random play orders
+ *
+ * Subclasses only need to override get_entry_weight() to return the
+ * right weight for a given entry.
  *
  * This class also delays committing any changes until the user moves to the
  * next or previous song. So if the user changes the entry-view to contain

Modified: trunk/shell/rb-play-order-random.h
==============================================================================
--- trunk/shell/rb-play-order-random.h	(original)
+++ trunk/shell/rb-play-order-random.h	Wed Apr 23 10:50:29 2008
@@ -43,16 +43,19 @@
 #define RB_IS_RANDOM_PLAY_ORDER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), RB_TYPE_RANDOM_PLAY_ORDER))
 #define RB_RANDOM_PLAY_ORDER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), RB_TYPE_RANDOM_PLAY_ORDER, RBRandomPlayOrderClass))
 
+typedef struct _RBRandomPlayOrder RBRandomPlayOrder;
+typedef struct _RBRandomPlayOrderClass RBRandomPlayOrderClass;
+
 typedef struct RBRandomPlayOrderPrivate RBRandomPlayOrderPrivate;
 
-typedef struct
+struct _RBRandomPlayOrder
 {
 	RBPlayOrder parent;
 
 	RBRandomPlayOrderPrivate *priv;
-} RBRandomPlayOrder;
+};
 
-typedef struct
+struct _RBRandomPlayOrderClass
 {
 	RBPlayOrderClass parent_class;
 
@@ -62,7 +65,7 @@
 	 * The @db will be locked when this method is called.
 	 */
 	double (*get_entry_weight) (RBRandomPlayOrder *rorder, RhythmDB *db, RhythmDBEntry *entry);
-} RBRandomPlayOrderClass;
+};
 
 GType				rb_random_play_order_get_type		(void);