From 93de7f375842c0afb72db8796c45bfda5f1a6f13 Mon Sep 17 00:00:00 2001
From: deva <deva>
Date: Fri, 25 Mar 2011 14:54:32 +0000
Subject: Finished documenting the last widgets. Also some changes in the
 docgen app.

---
 client/widgets/checkbox.h | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

(limited to 'client/widgets/checkbox.h')

diff --git a/client/widgets/checkbox.h b/client/widgets/checkbox.h
index de71732..92cc4b3 100644
--- a/client/widgets/checkbox.h
+++ b/client/widgets/checkbox.h
@@ -31,10 +31,14 @@
 #include <QDomNode>
 
 /***
- * CheckBox Widget.
+ * CheckBox Widget
  * @tag checkbox
  * @extends widget
  * @screenshot
+ * This widget is used to retrieve boolean values from the user. The widget can
+ * either be in checked state or unschecked state. The value of the widget
+ * depends on its state and the values of the falseval and trueval attributes.
+ * @att caption The caption of the checkbox.
  * @att trueval The value of the widget if it is checked.
  * @att falseval The value of the widget if it is unchecked.
  */
@@ -68,7 +72,7 @@ private:
 };
 
 /***
- * @method checked()
+ * @method boolean checked()
  * This method retrives the current check state of the checkbox.
  * @return the boolean value true if the checkbox is checked. Return
  * false if not.
@@ -76,7 +80,7 @@ private:
 int chk_checked(lua_State *L);
 
 /***
- * @method setChecked(checked)
+ * @method nil setChecked(boolean checked)
  * This method sets the current check state of the checkbox.
  * @param checked A boolean value. If the value is true the checkbox is set to
  * the state 'checked', otherwise it is set to the state 'unchecked'.
-- 
cgit v1.2.3