Enlightenment CVS committal
Author : rbdpngn
Project : e17
Module : libs/ewl
Dir : e17/libs/ewl/src
Modified Files:
ewl_entry.c ewl_entry.h
Log Message:
Added documentation for the entry widget.
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_entry.c,v
retrieving revision 1.64
retrieving revision 1.65
diff -u -3 -r1.64 -r1.65
--- ewl_entry.c 25 Aug 2003 19:40:42 -0000 1.64
+++ ewl_entry.c 28 Aug 2003 06:20:54 -0000 1.65
@@ -30,11 +30,9 @@
Ewl_Orientation o);
/**
- * ewl_entry_new - allocate and initialize a new entry widget
- * @text: the initial text to display in the widget
- *
- * Returns a newly allocated and initialized entry widget on success, NULL on
- * failure.
+ * @param text: the initial text to display in the widget
+ * @return Returns a new entry widget on success, NULL on failure.
+ * @brief Allocate and initialize a new entry widget
*/
Ewl_Widget *ewl_entry_new(char *text)
{
@@ -54,12 +52,12 @@
}
/**
- * ewl_entry_init - initialize an entry widget to default values
- * @e: the entry widget to initialize
- * @text: the initial text to display in the widget
+ * @param e: the entry widget to initialize
+ * @param text: the initial text to display in the widget
+ * @return Returns no value.
+ * @brief Initialize an entry widget to default values
*
- * Returns no value. Initializes the entry widget @e to it's default values
- * and callbacks.
+ * Initializes the entry widget @a e to it's default values and callbacks.
*/
void ewl_entry_init(Ewl_Entry * e, char *text)
{
@@ -104,11 +102,12 @@
}
/**
- * ewl_entry_set_text - set the text for an entry widget
- * @e: the entry widget to change the text
- * @t: the text to set for the entry widget
+ * @param e: the entry widget to change the text
+ * @param t: the text to set for the entry widget
+ * @return Returns no value.
+ * @brief Set the text for an entry widget
*
- * Returns no value. Change the text of the entry widget @e to the string @t.
+ * Change the text of the entry widget @a e to the string @a t.
*/
void ewl_entry_set_text(Ewl_Entry * e, char *t)
{
@@ -126,11 +125,9 @@
}
/**
- * ewl_entry_get_text - get the text from an entry widget
- * @e: the entry widget to retrieve the text
- *
- * Returns the text contained in the entry widget @e on success, NULL on
- * failure.
+ * @param e: the entry widget to retrieve the text
+ * @return Returns the entry text on success, NULL on failure.
+ * @brief Get the text from an entry widget
*/
char *ewl_entry_get_text(Ewl_Entry * e)
{
@@ -145,11 +142,10 @@
}
/**
- * ewl_entry_set_editable - change the ability to edit the text in an entry
- * @e: then entry to change
- * @edit: a boolean value indicating the ability to edit the entry
- *
- * Returns no value.
+ * @param e: then entry to change
+ * @param edit: a boolean value indicating the ability to edit the entry
+ * @return Returns no value.
+ * @brief Change the ability to edit the text in an entry
*/
void
ewl_entry_set_editable(Ewl_Entry *e, unsigned int edit)
===================================================================
RCS file: /cvsroot/enlightenment/e17/libs/ewl/src/ewl_entry.h,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -3 -r1.21 -r1.22
--- ewl_entry.h 7 Jun 2003 15:38:20 -0000 1.21
+++ ewl_entry.h 28 Aug 2003 06:20:54 -0000 1.22
@@ -2,18 +2,36 @@
#ifndef __EWL_ENTRY_H__
#define __EWL_ENTRY_H__
-typedef struct _ewl_entry Ewl_Entry;
+/**
+ * @file ewl_entry.h
+ * Defines the Ewl_Entry class to allow for single line editable text.
+ */
+/**
+ * Inherits from the Ewl_Widget and provides single line editable text.
+ */
+typedef struct Ewl_Entry Ewl_Entry;
+
+/**
+ * @def EWL_ENTRY(entry)
+ * Typecasts a pointer to an Ewl_Entry pointer.
+ */
#define EWL_ENTRY(entry) ((Ewl_Entry *) entry)
-struct _ewl_entry {
- Ewl_Container container;
+/**
+ * @struct Ewl_Entry
+ * Inherits from the Ewl_Container and extends it to provide text and a cursor
+ * for editing the contents of the text.
+ */
+struct Ewl_Entry
+{
+ Ewl_Container container; /**< Inherit from Ewl_Container */
- Ewl_Widget *text;
- Ewl_Widget *cursor;
+ Ewl_Widget *text; /**< Provide Ewl_Text for text display */
+ Ewl_Widget *cursor; /**< Provide Ewl_Cursor for cursor display */
- int offset;
- int editable;
+ int offset; /**< Starting position of cursor in text */
+ int editable; /**< Flag to indicate if user can edit text */
};
Ewl_Widget *ewl_entry_new(char *text);
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
_______________________________________________
enlightenment-cvs mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
