summaryrefslogtreecommitdiff
path: root/client/widgets/widget.h
diff options
context:
space:
mode:
authordeva <deva>2011-03-29 10:04:47 +0000
committerdeva <deva>2011-03-29 10:04:47 +0000
commitd7044d310387d3752774831c1a8a768c0ca1ed67 (patch)
tree47d0e23b2f5b09d67c9774392c3cc98133055d6b /client/widgets/widget.h
parent14934de96713aa8864f103e7376022859c2ee508 (diff)
Examples in docs.
Diffstat (limited to 'client/widgets/widget.h')
-rw-r--r--client/widgets/widget.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/client/widgets/widget.h b/client/widgets/widget.h
index ef23294..bb37c51 100644
--- a/client/widgets/widget.h
+++ b/client/widgets/widget.h
@@ -215,7 +215,8 @@ int wdg_set_visible(lua_State *L);
/***
* @method boolean valid()
- * This method is used to get the current validity state of the widget.
+ * This method is used to get the current validity state of the widget. See
+ * also @see setValid().
* @return a boolean value. If the widget is valid the method returns true
* otherwise it returns false.
*/
@@ -225,7 +226,7 @@ int wdg_valid(lua_State *L);
* @method nil setValid(boolean valid)
* This method is used to set the widgets validity state. Most widgets have a
* visual indication of their validity state (a red background colour for
- * example) and this will also be set using this method.
+ * example) and this will also be set using this method. See also @see valid().
* <em>NOTE</em>: An invalid widget that are not an inner widget will block a
* server commit.
* @param valid A boolean value. If true the widgets validity state is set to