rhythmbox r5628 - in trunk: . widgets

[jmatthew svn gnome org]

Author: jmatthew
Date: Tue Mar 18 12:57:09 2008
New Revision: 5628
URL: http://svn.gnome.org/viewvc/rhythmbox?rev=5628&view=rev

Log:
2008-03-18  Jonathan Matthew  <jonathan d14n org>

	* widgets/rb-uri-dialog.c: (rb_uri_dialog_class_init):
	Add gtk-doc stuff for RBURIDialog.


Modified:
   trunk/ChangeLog
   trunk/widgets/rb-uri-dialog.c

Modified: trunk/widgets/rb-uri-dialog.c
==============================================================================
--- trunk/widgets/rb-uri-dialog.c	(original)
+++ trunk/widgets/rb-uri-dialog.c	Tue Mar 18 12:57:09 2008
@@ -35,6 +35,14 @@
 #include "rb-dialog.h"
 #include "rb-debug.h"
 
+/**
+ * SECTION:rb-uri-dialog
+ * @short_description: simple URI entry dialog
+ * @include: rb-uri-dialog.h
+ *
+ * A simple dialog used to request a single URI from the user.
+ */
+
 static void rb_uri_dialog_class_init (RBURIDialogClass *klass);
 static void rb_uri_dialog_init (RBURIDialog *dialog);
 static void rb_uri_dialog_finalize (GObject *object);
@@ -87,6 +95,11 @@
 	object_class->set_property = rb_uri_dialog_set_property;
 	object_class->get_property = rb_uri_dialog_get_property;
 
+	/**
+	 * rb-uri-dialog:label:
+	 *
+	 * The label displayed in the dialog.
+	 */
 	g_object_class_install_property (object_class,
 					 PROP_LABEL,
 					 g_param_spec_string ("label",
@@ -95,6 +108,12 @@
 							      "",
 					                      G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 
+	/**
+	 * rb-uri-dialog::location-added:
+	 * @uri: URI entered
+	 *
+	 * Emitted when the user has entered a URI into the dialog.
+	 */
 	rb_uri_dialog_signals [LOCATION_ADDED] =
 		g_signal_new ("location-added",
 			      G_OBJECT_CLASS_TYPE (object_class),
@@ -211,6 +230,15 @@
 	}
 }
 
+/**
+ * rb_uri_dialog_new:
+ * @title: Window title for the dialog
+ * @label: Label to display in the dialog
+ *
+ * Creates a URI entry dialog.
+ *
+ * Returns: URI dialog instance.
+ */
 GtkWidget *
 rb_uri_dialog_new (const char *title, const char *label)
 {