rhythmbox r5820 - in trunk: . sources

[jmatthew svn gnome org]

Author: jmatthew
Date: Sun Jul 27 00:48:27 2008
New Revision: 5820
URL: http://svn.gnome.org/viewvc/rhythmbox?rev=5820&view=rev

Log:
2008-07-27  Jonathan Matthew  <jonathan d14n org>

	* sources/rb-podcast-source.c:
	* sources/rb-podcast-source.h:
	Add gtkdoc for RBPodcastSource, for what little it's worth


Modified:
   trunk/ChangeLog
   trunk/sources/rb-podcast-source.c
   trunk/sources/rb-podcast-source.h

Modified: trunk/sources/rb-podcast-source.c
==============================================================================
--- trunk/sources/rb-podcast-source.c	(original)
+++ trunk/sources/rb-podcast-source.c	Sun Jul 27 00:48:27 2008
@@ -28,6 +28,16 @@
  *
  */
 
+/**
+ * SECTION:rb-podcast-source
+ * @short_description: source displaying podcast feeds and episodes
+ *
+ * The podcast source displays podcast episodes in its entry view
+ * and podcast feeds in a property view.  It uses a few custom columns
+ * to display podcast-specific information: episode download status
+ * and an indication of feed parsing errors.
+ */
+
 #include "config.h"
 
 #include <string.h>
@@ -877,6 +887,14 @@
 	}
 }
 
+/**
+ * rb_podcast_source_new:
+ * @shell: the #RBShell instance
+ *
+ * Creates the #RBPodcastSource instance
+ *
+ * Return value: the #RBPodcastSource
+ */
 RBSource *
 rb_podcast_source_new (RBShell *shell)
 {
@@ -1357,6 +1375,14 @@
 	impl_receive_drag (RB_SOURCE (source), selection_data);
 }
 
+/**
+ * rb_podcast_source_add_feed:
+ * @source: the #RBPodcastSource
+ * @uri: the new feed to add
+ *
+ * Adds a new podcast feed.
+ * Simply calls #rb_podcast_manager_subscribe_feed.
+ */
 void
 rb_podcast_source_add_feed (RBPodcastSource *source, const char *uri)
 {

Modified: trunk/sources/rb-podcast-source.h
==============================================================================
--- trunk/sources/rb-podcast-source.h	(original)
+++ trunk/sources/rb-podcast-source.h	Sun Jul 27 00:48:27 2008
@@ -42,19 +42,22 @@
 #define RB_IS_PODCAST_SOURCE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), RB_TYPE_PODCAST_SOURCE))
 #define RB_PODCAST_SOURCE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), RB_TYPE_PODCAST_SOURCE, RBPodcastSourceClass))
 
+typedef struct _RBPodcastSource RBPodcastSource;
+typedef struct _RBPodcastSourceClass RBPodcastSourceClass;
+
 typedef struct RBPodcastSourcePrivate RBPodcastSourcePrivate;
 
-typedef struct
+struct _RBPodcastSource
 {
 	RBSource parent;
 
 	RBPodcastSourcePrivate *priv;
-} RBPodcastSource;
+};
 
-typedef struct
+struct _RBPodcastSourceClass
 {
 	RBSourceClass parent;
-} RBPodcastSourceClass;
+};
 
 GType		rb_podcast_source_get_type	(void);
 RBSource *	rb_podcast_source_new		(RBShell *shell);