Update docs of GtkAboutDialog and GtkLinkButton

[~andy/gtk] / gtk / gtklinkbutton.c

diff --git a/gtk/gtklinkbutton.c b/gtk/gtklinkbutton.c
index 85de592c0f21a032c87f726339d0835d050d7943..027c7ee52465a91a85389410ca5bbe7445df7013 100644 (file)
--- a/gtk/gtklinkbutton.c
+++ b/gtk/gtklinkbutton.c
@@ -22,6 +22,28 @@
  * Foundation, Inc., 59 Temple Place - Suite 330, Cambridge, MA 02139, USA.
  */
 
+/**
+ * SECTION:gtklinkbutton
+ * @Title: GtkLinkButton
+ * @Short_description: Create buttons bound to a URL
+ * @See_also: #GtkButton
+ *
+ * A GtkLinkButton is a #GtkButton with a hyperlink, similar to the one
+ * used by web browsers, which triggers an action when clicked. It is useful
+ * to show quick links to resources.
+ *
+ * A link button is created by calling either gtk_link_button_new() or
+ * gtk_link_button_new_with_label(). If using the former, the URI you pass
+ * to the constructor is used as a label for the widget.
+ *
+ * The URI bound to a GtkLinkButton can be set specifically using
+ * gtk_link_button_set_uri(), and retrieved using gtk_link_button_get_uri().
+ *
+ * By default, GtkLinkButton calls gtk_show_uri() when the button is
+ * clicked. This behaviour can be overridden by connecting to the
+ * #GtkButton::clicked signal.
+ */
+
 #include "config.h"
 
 #include "gtklinkbutton.h"