From ffb2dbf7220bfb02d6f5abe0170fd10134eb6516 Mon Sep 17 00:00:00 2001 From: shilpa Date: Mon, 14 Jun 2010 18:49:48 +0900 Subject: [PATCH] [popup,notify,entry,scrolled entry,titlebar,autocompleteview]: doxygen comments reviewed, if issues found then modified. --- src/lib/elc_scrolled_entry.c | 17 +++++++++-------- src/lib/elm_autocompleteview.c | 38 +++++++++++++++++++------------------- src/lib/elm_entry.c | 11 ++++++----- src/lib/elm_notify.c | 16 ++++++++++++---- src/lib/elm_popup.c | 29 +++++++++++++++-------------- src/lib/elm_titlebar.c | 14 +++++++------- 6 files changed, 68 insertions(+), 57 deletions(-) diff --git a/src/lib/elc_scrolled_entry.c b/src/lib/elc_scrolled_entry.c index d2312e3..9638927 100755 --- a/src/lib/elc_scrolled_entry.c +++ b/src/lib/elc_scrolled_entry.c @@ -934,10 +934,10 @@ elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_ elm_scroller_bounce_set(wd->scroller, h_bounce, v_bounce); } /** - * This set's the maximum bytes that can be added in entry. + * This set's the maximum bytes that can be added in to scrolled entry. * - * @param obj The entry object - * @param max_no_of_bytes Maximum number of bytes entry can have + * @param obj The scrolled entry object + * @param max_no_of_bytes Maximum number of bytes scrolled entry can have. * * @ingroup Scrolled_Entry */ @@ -951,11 +951,12 @@ elm_scrolled_entry_maximum_bytes_set(Evas_Object *obj, int max_no_of_bytes) } /** - * Whether the character to use when masking entry contents (in "password mode"). - * shows last character to user while password is being typed. - * @param obj The entry object - * @param password The password flag (1 for "password mode" to show the user - * how many characters have been typed, 0 for default) + * This set's the scrolled entry in password mode with out masking the last character entered by user, + * and later masking the character after 2 seconds. + * + * @param obj The scrolled entry object + * @param show_last_character The show_last_character flag (1 for "password mode along with showing last character" + * 0 for default) * * @ingroup Scrolled_Entry */ diff --git a/src/lib/elm_autocompleteview.c b/src/lib/elm_autocompleteview.c index 86c1e36..880164b 100755 --- a/src/lib/elm_autocompleteview.c +++ b/src/lib/elm_autocompleteview.c @@ -213,10 +213,10 @@ elm_autocompleteview_add(Evas_Object *parent) /** - * Get the entry of the Autocompleteview object + * This Get's the entry object of Autocompleteview object. * - * @param obj The Autocompleteview object - * @return entry object + * @param obj The Autocompleteview object. + * @return the entry object. * * @ingroup Autocompleteview */ @@ -232,10 +232,10 @@ elm_autocompleteview_entry_get(Evas_Object *obj) } /** - * Get the editfiled of the Autocompleteview object + * This Get's the editfield object of the Autocompleteview object. * - * @param obj The Autocompleteview object - * @return editfield object + * @param obj The Autocompleteview object. + * @return The Editfield object. * * @ingroup Autocompleteview */ @@ -252,8 +252,8 @@ elm_autocompleteview_editfield_get(Evas_Object *obj) /** - * Specifies the minimum number of characters the user has to type in the editfield - * before the drop down list is shown.When threshold is less than or equals 0, a threshold of 1 is applied. + * This Specifies the minimum number of characters the user has to type in the editfield + * before the drop down list is shown.When threshold is less than or equals 0, a threshold of 1 is applied by default. * * @param obj The Autocompleteview object * @param threshold the number of characters to type before the drop down is shown @@ -279,10 +279,10 @@ elm_autocompleteview_threshold_set(Evas_Object *obj, int threshold) /** - * Returns the number of characters the user must type before the drop down list is shown. + * This Returns the number of characters the user must type before the drop down list is shown. * - * @param obj The Autocompleteview object - * @return The threshold value + * @param obj The Autocompleteview object. + * @return The threshold value. * * @ingroup Autocompleteview */ @@ -299,11 +299,10 @@ elm_autocompleteview_threshold_get(Evas_Object *obj) /** - * Specifies the list of strings which has to be searched to get the completion strings. - * + * This Specifies the list of strings which has to be searched to get the list of completion strings. * * @param obj The Autocompleteview object - * @param data_list the list of static strings, which has to be searched to get the completion string. + * @param data_list the list of static strings, which has to be searched to get the completion strings. * * @ingroup Autocompleteview */ @@ -323,12 +322,12 @@ elm_autocompleteview_data_set(Evas_Object *obj, Eina_List *data_list) /** - * Registers the callback function that would be called whenever text is entered in to the entry.. - * + * This Registers the callback function that would be called whenever text is entered in to the entry. * * @param obj The Autocompleteview object * @param elmautocompleteview_matchfunction completion function which list's the completion strings. * @param data userdata that would be passed whenever the callback function is called. + * * @ingroup Autocompleteview */ EAPI void @@ -342,12 +341,13 @@ elm_autocompleteview_match_func_set(Evas_Object *obj, elmautocompleteview_matchf wd->func = func; wd->data = data; } + /** - * updates the text in to autocomplete view. - * + * This updates the text in to autocomplete view. * * @param obj The Autocompleteview object - * @param text the text to be updated in to entry of autocompleteview. + * @param text the text to be updated in to the entry of autocompleteview. + * * @ingroup Autocompleteview */ EAPI void diff --git a/src/lib/elm_entry.c b/src/lib/elm_entry.c index f566a19..d138e2f 100755 --- a/src/lib/elm_entry.c +++ b/src/lib/elm_entry.c @@ -1815,7 +1815,7 @@ elm_entry_single_line_get(const Evas_Object *obj) * This set's the maximum bytes that can be added in entry. * * @param obj The entry object - * @param max_no_of_bytes Maximum number of bytes entry can have + * @param max_no_of_bytes Maximum number of bytes entry can have. * * @ingroup Entry */ @@ -1860,11 +1860,12 @@ elm_entry_password_set(Evas_Object *obj, Eina_Bool password) } /** - * Whether the character to use when masking entry contents (in "password mode"). - * shows last character to user while password is being typed. + * This set's the entry in password mode with out masking the last character entered by user, + * and later masking the character after 2 seconds. + * @param obj The entry object - * @param password The password flag (1 for "password mode" to show the user - * how many characters have been typed, 0 for default) + * @param show_last_character The show_last_character flag (1 for "password mode along with showing last character" + * 0 for default). * * @ingroup Entry */ diff --git a/src/lib/elm_notify.c b/src/lib/elm_notify.c index 0b59c35..1833491 100755 --- a/src/lib/elm_notify.c +++ b/src/lib/elm_notify.c @@ -375,6 +375,8 @@ elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) * * @param obj The notify object * @param orient The new orientation + * + * @ingroup Notify */ EAPI void elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) @@ -422,6 +424,8 @@ elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) * * @param obj The notify object * @param time the new timeout + * + * @ingroup Notify */ EAPI void elm_notify_timeout_set(Evas_Object *obj, int timeout) @@ -434,8 +438,10 @@ elm_notify_timeout_set(Evas_Object *obj, int timeout) } /** - * Re-init the timer + * Re-initialize the timer * @param obj The notify object + * + * @ingroup Notify */ EAPI void elm_notify_timer_init(Evas_Object *obj) @@ -451,13 +457,15 @@ elm_notify_timer_init(Evas_Object *obj) /** * When true if the user clicks outside the window the events will be - * catch by the others widgets, else the events are block and the signal - * dismiss will be sent when the user click outside the window. + * caught by other widgets, else the events are blocked and the signal + * block,clicked will be sent when the user click's outside the window. * * @note The default value is EINA_TRUE. * * @param obj The notify object - * @param repeats EINA_TRUE Events are repeats, else no + * @param repeats EINA_TRUE Events are repeated else The events are blocked. + * + * @ingroup Notify */ EAPI void elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) diff --git a/src/lib/elm_popup.c b/src/lib/elm_popup.c index f3a71e6..13622c8 100755 --- a/src/lib/elm_popup.c +++ b/src/lib/elm_popup.c @@ -368,7 +368,7 @@ elm_popup_add_with_buttons(Evas_Object *parent, char *title, char *desc_text,int } /** - * Set the description text in content area of Popup widget. + * This Set's the description text in content area of Popup widget. * * @param text description text. * @@ -402,7 +402,7 @@ elm_popup_desc_set(Evas_Object *obj, const char *text) } /** - * Get the description text packed in content area of popup object. + * This Get's the description text packed in content area of popup object. * * @param obj The Popup object * @return description text. @@ -419,7 +419,7 @@ elm_popup_desc_get(Evas_Object *obj) } /** - * Set's the title label of popup object. + * This Set's the title text in title area of popup object. * * @param obj The popup object * @param text The title text @@ -456,7 +456,7 @@ elm_popup_title_label_set(Evas_Object *obj, const char *text) } /** - * Get's the title label of popup object. + * This Get's the title text packed in title area of popup object. * * @param obj The Popup object * @return title text @@ -473,7 +473,7 @@ elm_popup_title_label_get(Evas_Object *obj) } /** - * Set the icon in the title area of Popup object. + * This Set's the icon in the title area of Popup object. * * @param obj The popup object * @param icon The title icon @@ -499,7 +499,7 @@ elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon) } /** - * Get the title icon of Popup object. + * This Get's the icon packed in title area of Popup object. * * @param obj The Popup object * @return title icon @@ -516,7 +516,7 @@ elm_popup_title_icon_get(Evas_Object *obj) } /** - * Set the content of Popup object. + * This Set's the content widget in content area of Popup object. * * @param obj The popup object * @param content The content widget @@ -542,7 +542,7 @@ elm_popup_content_set(Evas_Object *obj, Evas_Object *content) } /** - * Get the content of Popup object. + * This Get's the content widget packed in content area of Popup object. * * @param obj The Popup object * @return content packed in popup widget @@ -606,10 +606,11 @@ elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, char *first_button_tex } /** - * Set the time before the popup window is hidden. + * This Set's the time before the popup window is hidden, + * and ELM_POPUP_RESPONSE_TIMEOUT is sent along with response signal. * * @param obj The popup object - * @param timeout The timeout + * @param timeout The timeout value in seconds. * * @ingroup Popup */ @@ -623,7 +624,7 @@ elm_popup_timeout_set(Evas_Object *obj, int timeout) } /** - * Set the mode of popup, by default ELM_POPUP_TYPE_NONE is set i.e, popup + * This Set's the mode of popup, by default ELM_POPUP_TYPE_NONE is set i.e, popup * will not close when clicked outside. if ELM_POPUP_TYPE_ALERT is set, popup will close * when clicked outside, and ELM_POPUP_RESPONSE_NONE is sent along with response signal. * @@ -632,7 +633,6 @@ elm_popup_timeout_set(Evas_Object *obj, int timeout) * * @ingroup Popup */ - EAPI void elm_popup_set_mode(Evas_Object *obj, Elm_Popup_Mode mode) { Widget_Data *wd = elm_widget_data_get(obj); @@ -641,7 +641,8 @@ EAPI void elm_popup_set_mode(Evas_Object *obj, Elm_Popup_Mode mode) } /** - * Hides the popup by emitting response signal + * This Hides the popup by emitting response signal. + * * @param obj The popup object * @param response_id response ID of the signal to be emitted along with response signal * @@ -656,7 +657,7 @@ EAPI void elm_popup_response(Evas_Object *obj, int response_id) } /** - * the direction from which popup will appear as well as the location of popup can be controlled by this API + * This API controls the direction from which popup will appear and location of popup. * @param obj The popup object * @param orient the orientation of the popup * diff --git a/src/lib/elm_titlebar.c b/src/lib/elm_titlebar.c index 0daf300..39dd99d 100755 --- a/src/lib/elm_titlebar.c +++ b/src/lib/elm_titlebar.c @@ -57,7 +57,7 @@ _sizing_eval(Evas_Object *obj) } /** - * Add a new titlebar object + * Add a new titlebar object. * * @param parent The parent object * @return The new object or NULL if it cannot be created @@ -97,7 +97,7 @@ elm_titlebar_add(Evas_Object *parent) } /** - * Set the label of titlebar object + * This set's the label in titlebar object. * * @param obj The titlebar object * @param label The label text @@ -117,7 +117,7 @@ elm_titlebar_label_set(Evas_Object *obj, const char *label) } /** - * Get the label used on the titlebar object + * This get's the label packed in titlebar object. * * @param obj The titlebar object * @return label text @@ -134,7 +134,7 @@ elm_titlebar_label_get(Evas_Object *obj) } /** - * Set the icon object of the titlebar object + * This set's the icon object in titlebar object. * * @param obj The titlebar object * @param icon The icon object @@ -166,7 +166,7 @@ elm_titlebar_icon_set(Evas_Object *obj, Evas_Object *icon) } /** - * Get the icon object of the titlebar object + * This get's the icon object packed in titlebar object. * * @param obj The titlebar object * @return The icon object @@ -183,7 +183,7 @@ elm_titlebar_icon_get(Evas_Object *obj) } /** - * Set the end object of the titlebar object + * This set's the end object in titlebar object. * * @param obj The titlebar object * @param end The end object @@ -214,7 +214,7 @@ elm_titlebar_end_set(Evas_Object *obj, Evas_Object *end) } /** - * Get the end object of the titlebar object + * This get's the end object packed in titlebar object. * * @param obj The titlebar object * @return The icon object -- 2.7.4