From 09c5c0783aef07e714c5613cbbf3a982774676aa Mon Sep 17 00:00:00 2001
From: deva <deva>
Date: Wed, 23 Mar 2011 08:02:32 +0000
Subject: Documentation step 1

---
 client/widgets/lineedit.h | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

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

diff --git a/client/widgets/lineedit.h b/client/widgets/lineedit.h
index 6ddb9af..5dbdc6b 100644
--- a/client/widgets/lineedit.h
+++ b/client/widgets/lineedit.h
@@ -31,6 +31,16 @@
 
 #include "widget.h"
 
+/***
+ * Line Edit Widget
+ * @tag lineedit
+ * @extends widget
+ * @screenshot
+ * The lineedit tag is used to insert a lineedit into the macro. It is used to
+ * gather textual input from the user, who using the keyboard will be able to
+ * express him or herself in plaintext.
+ */
+
 class QLineEdit;
 class QEvent;
 class LineEdit : public Widget
@@ -65,8 +75,26 @@ private:
 };
 
 int lin_clear_suggestions(lua_State *L);
+
 int lin_show_suggestions(lua_State *L);
+
+/***
+ * @method isSuggested(value)
+ * This method makes a lookup in the suggestion list, searching for value.
+ * @param value A string containing the text to look for in the suggestion list.
+ * @return a boolean with the value true if the string was found, false
+ * if not.
+ */
 int lin_is_suggested(lua_State *L);
+
+/***
+ * @method addSuggestion(suggestion)
+ * Adds a suggestion to the suggestion list. The list is popped up each time 
+ * a character is entered into the lineedit by the user, or it is explicitly
+ * opened by calling @ref showSuggestions().
+ * @param suggestion A string containing the value to be added to the
+ * suggestion list.
+ */
 int lin_add_suggestion(lua_State *L);
 
 #define LINEDT_METHS \
-- 
cgit v1.2.3