From: Thiep Ha Date: Tue, 24 Oct 2017 06:13:07 +0000 (+0900) Subject: doc: add missing parameters and fix references for some elm widgets X-Git-Tag: submit/tizen/20171025.103743~2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0bb5bae918c056eba532bd94f5a9ffeeb1458117;p=platform%2Fupstream%2Felementary.git doc: add missing parameters and fix references for some elm widgets Change-Id: Iced4250100d557e0fd180f554683558f3c8e93dc --- diff --git a/src/lib/elm_button.h b/src/lib/elm_button.h index 2639c255b..ae1b96e1e 100644 --- a/src/lib/elm_button.h +++ b/src/lib/elm_button.h @@ -19,7 +19,7 @@ * functions acting on it also work for button objects. * * This widget emits the following signals, besides the ones sent from - * @ref Elm_Layout: + * @ref Elm_Layout : * @li "clicked": the user clicked the button (press/release). * @li "repeated": the user pressed the button without releasing it. * @li "pressed": button was pressed. diff --git a/src/lib/elm_calendar.h b/src/lib/elm_calendar.h index b52cc323c..113a48c80 100644 --- a/src/lib/elm_calendar.h +++ b/src/lib/elm_calendar.h @@ -21,7 +21,7 @@ * functions acting on it also work for calendar objects. * * This widget emits the following signals, besides the ones sent from - * @ref Elm_Layout: + * @ref Elm_Layout : * - @c "changed" - emitted when the date in the calendar is changed. * - @c "display,changed" - emitted when the current month displayed in the * calendar is changed. diff --git a/src/lib/elm_check.h b/src/lib/elm_check.h index 10c489947..114f712a4 100644 --- a/src/lib/elm_check.h +++ b/src/lib/elm_check.h @@ -27,7 +27,7 @@ * functions acting on it also work for check objects. * * This widget emits the following signals, besides the ones sent from - * @ref Elm_Layout: + * @ref Elm_Layout : * - @c "changed" - This is called whenever the user changes the state of * the check objects (@p event_info is always @c NULL). * - @c "focused" - When the check has received focus. (since 1.8) diff --git a/src/lib/elm_colorselector.h b/src/lib/elm_colorselector.h index c58dda12e..8c08eca44 100644 --- a/src/lib/elm_colorselector.h +++ b/src/lib/elm_colorselector.h @@ -19,7 +19,7 @@ * functions acting on it also work for check objects. * * This widget emits the following signals, besides the ones sent from - * @ref Elm_Layout: + * @ref Elm_Layout : * - @c "changed" - When the color value changes on selector * event_info is NULL. * - @c "color,item,selected" - When user clicks on color item. The diff --git a/src/lib/elm_config.h b/src/lib/elm_config.h index 3644cab87..efd618c37 100644 --- a/src/lib/elm_config.h +++ b/src/lib/elm_config.h @@ -355,6 +355,9 @@ EAPI void elm_config_scroll_page_scroll_friction_set(double friction); * Get enable status of context menu disabled. * * @see elm_config_context_menu_disabled_set() + * + * @return @c EINA_TRUE if context menu is disabled, otherwise @c EINA_FALSE. + * * @ingroup Elm_Entry * @since 1.17 */ diff --git a/src/lib/elm_conform.h b/src/lib/elm_conform.h index 7f9f84998..ce16fd440 100644 --- a/src/lib/elm_conform.h +++ b/src/lib/elm_conform.h @@ -23,7 +23,7 @@ * functions acting on it also work for conformant objects. * * This widget emits the following signals, besides the ones sent from - * @ref Elm_Layout: + * @ref Elm_Layout : * @li "virtualkeypad,state,on": if virtualkeypad state is switched to "on". * (since 1.8) * @li "virtualkeypad,state,off": if virtualkeypad state is switched to "off". diff --git a/src/lib/elm_entry.h b/src/lib/elm_entry.h index a1ffade47..dc93374b3 100644 --- a/src/lib/elm_entry.h +++ b/src/lib/elm_entry.h @@ -231,7 +231,7 @@ * @section entry-signals Emitted signals * * This widget emits the following signals, besides the ones sent from - * @ref Elm_Layout: + * @ref Elm_Layout : * @li "aborted": The escape key was pressed on a single line entry. (since 1.7) * @li "activated": The enter key was pressed on a single line entry. * @li "anchor,clicked": An anchor has been clicked. The event_info diff --git a/src/lib/elm_entry_legacy.h b/src/lib/elm_entry_legacy.h index 218eb0988..468887f46 100644 --- a/src/lib/elm_entry_legacy.h +++ b/src/lib/elm_entry_legacy.h @@ -65,6 +65,7 @@ EAPI const char *elm_entry_entry_get(const Evas_Object *obj); * * @ingroup Elm_Entry * + * @param[in] obj The entry object * @param[in] file The path to the file to load and save * @param[in] format The file format * @@ -83,6 +84,7 @@ EAPI Eina_Bool elm_entry_file_set(Evas_Object *obj, const char *file, E * * @ingroup Elm_Entry * + * @param[in] obj The entry object * @param[out] file The path to the file to load and save * @param[out] format The file format * diff --git a/src/lib/elm_layout.h b/src/lib/elm_layout.h index 3eb1f73ce..47781c719 100644 --- a/src/lib/elm_layout.h +++ b/src/lib/elm_layout.h @@ -103,10 +103,10 @@ * table by specifying the row and column where the object should be * added, and any column or row span, if necessary. * - * Again, we could have this design by adding a @ref table widget to a + * Again, we could have this design by adding a @ref Elm_Table widget to a * @c SWALLOW part, using elm_layout_content_set(). The same * difference happens here when choosing to use the layout table (a - * @c TABLE part) instead of the @ref table in a @c SWALLOW part. It's + * @c TABLE part) instead of the @ref Elm_Table in a @c SWALLOW part. It's * just a matter of convenience. * * The layout table can be used through the @c elm_layout_table_* set of