summaryrefslogtreecommitdiff
path: root/gtk/gtkcheckbutton.c
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2011-04-13 12:25:06 +0100
committerJavier Jardón <jjardon@gnome.org>2011-04-13 12:25:06 +0100
commit7b2113fd32680e3df6c8a32f33fad9f6bdabb8fb (patch)
treeea3a4caf34486cc9b6ff83d273e1266cba52866a /gtk/gtkcheckbutton.c
parent5d106e6ee54684f5d175905d4af312797ebb40e1 (diff)
downloadgtk+-7b2113fd32680e3df6c8a32f33fad9f6bdabb8fb.tar.gz
Move documentation to inline comments: GtkCheckButton
Diffstat (limited to 'gtk/gtkcheckbutton.c')
-rw-r--r--gtk/gtkcheckbutton.c32
1 files changed, 31 insertions, 1 deletions
diff --git a/gtk/gtkcheckbutton.c b/gtk/gtkcheckbutton.c
index 5b9d35d3c5..9ceb6b1b28 100644
--- a/gtk/gtkcheckbutton.c
+++ b/gtk/gtkcheckbutton.c
@@ -35,6 +35,21 @@
#include "gtkintl.h"
+/**
+ * SECTION:gtkcheckbutton
+ * @Short_description: Create widgets with a discrete toggle button
+ * @Title: GtkCheckButton
+ * @See_also: #GtkCheckMenuItem, #GtkButton, #GtkToggleButton, #GtkRadioButton
+ *
+ * A #GtkCheckButton places a discrete #GtkToggleButton next to a widget,
+ * (usually a #GtkLabel). See the section on #GtkToggleButton widgets for
+ * more information about toggle/check buttons.
+ *
+ * The important signal ( #GtkToggleButton::toggled ) is also inherited from
+ * #GtkToggleButton.
+ */
+
+
#define INDICATOR_SIZE 16
#define INDICATOR_SPACING 2
@@ -99,6 +114,13 @@ gtk_check_button_init (GtkCheckButton *check_button)
gtk_button_set_alignment (GTK_BUTTON (check_button), 0.0, 0.5);
}
+/**
+ * gtk_check_button_new:
+ *
+ * Creates a new #GtkCheckButton.
+ *
+ * Returns: a #GtkWidget.
+ */
GtkWidget*
gtk_check_button_new (void)
{
@@ -106,6 +128,14 @@ gtk_check_button_new (void)
}
+/**
+ * gtk_check_button_new_with_label:
+ * @label: the text for the check button.
+ *
+ * Creates a new #GtkCheckButton with a #GtkLabel to the right of it.
+ *
+ * Returns: a #GtkWidget.
+ */
GtkWidget*
gtk_check_button_new_with_label (const gchar *label)
{
@@ -115,7 +145,7 @@ gtk_check_button_new_with_label (const gchar *label)
/**
* gtk_check_button_new_with_mnemonic:
* @label: The text of the button, with an underscore in front of the
- * mnemonic character
+ * mnemonic character
* @returns: a new #GtkCheckButton
*
* Creates a new #GtkCheckButton containing a label. The label