HildonCheckButton documentation updates

* hildon/hildon-check-button.c:
Documentation updates

Fixes: MB#4598 (HildonCheckButton documentation doesn't say why it
exists)

diff --git a/ChangeLog b/ChangeLog
index f21fca7..1e27229 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,13 @@
 2009-06-15  Alberto Garcia  <agarcia@igalia.com>
 
+       * hildon/hildon-check-button.c:
+       Documentation updates
+
+       Fixes: MB#4598 (HildonCheckButton documentation doesn't say why it
+       exists)
+
+2009-06-15  Alberto Garcia  <agarcia@igalia.com>
+
        * hildon/Makefile.am
        * hildon/hildon-edit-toolbar-private.h
        * hildon/hildon-edit-toolbar.c

diff --git a/hildon/hildon-check-button.c b/hildon/hildon-check-button.c
index 7283b89..bad22cc 100644 (file)
--- a/hildon/hildon-check-button.c
+++ b/hildon/hildon-check-button.c
@@ -22,6 +22,10 @@
  * which will remain 'pressed-in' when clicked. Clicking again will
  * make the check box toggle its state.
  *
+ * #HildonCheckButton is similar to the #GtkCheckButton widget, but
+ * with a different appearance that combines a standard button and a
+ * check box.
+ *
  * The state of a #HildonCheckButton can be set using
  * hildon_check_button_set_active(), and retrieved using
  * hildon_check_button_get_active(). The label can be set using