Documentation step 1

1 files changed, 22 insertions, 0 deletions

diff --git a/client/widgets/checkbox.h b/client/widgets/checkbox.h
index 0930d50..de71732 100644
--- a/client/widgets/checkbox.h
+++ b/client/widgets/checkbox.h
@@ -30,6 +30,15 @@
 #include "widget.h"
 #include <QDomNode>
 
+/***
+ * CheckBox Widget.
+ * @tag checkbox
+ * @extends widget
+ * @screenshot
+ * @att trueval The value of the widget if it is checked.
+ * @att falseval The value of the widget if it is unchecked.
+ */
+
 class QCheckBox;
 class CheckBox : public Widget
 {
@@ -58,7 +67,20 @@ private:
   QCheckBox *checkbox;
 };
 
+/***
+ * @method 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.
+ */
 int chk_checked(lua_State *L);
+
+/***
+ * @method setChecked(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'.
+ */
 int chk_set_checked(lua_State *L);
 
 #define CHKBOX_METHS \