From 439286216b456272f7ae84361c86707f3c00ae62 Mon Sep 17 00:00:00 2001 From: Sanjeev BA Date: Thu, 16 Feb 2012 08:28:36 +0000 Subject: [PATCH] Documentation fixes and more API feedback. Signed-off-by: Sanjeev BA SVN revision: 68014 --- src/lib/elm_progressbar.h | 17 ++++++++--------- src/lib/elm_radio.h | 24 ++++++++++++++++-------- src/lib/elm_scroll.h | 2 +- src/lib/elm_segment_control.h | 2 +- 4 files changed, 26 insertions(+), 19 deletions(-) diff --git a/src/lib/elm_progressbar.h b/src/lib/elm_progressbar.h index 8ec98db..97bbcf7 100644 --- a/src/lib/elm_progressbar.h +++ b/src/lib/elm_progressbar.h @@ -13,18 +13,17 @@ * value. Label, icon and unit strings/objects are @b optional * for progress bars. * - * A progress bar may be @b inverted, in which state it gets its - * values inverted, with high values being on the left or top and - * low values on the right or bottom, as opposed to normally have - * the low values on the former and high values on the latter, - * respectively, for horizontal and vertical modes. + * A progress bar may be @b inverted, in which case it gets its + * values inverted, i.e., high values being on the left or top and + * low values on the right or bottom, for horizontal and vertical modes + * respectively. * * The @b span of the progress, as set by * elm_progressbar_span_size_set(), is its length (horizontally or * vertically), unless one puts size hints on the widget to expand * on desired directions, by any container. That length will be - * scaled by the object or applications scaling factor. At any - * point code can query the progress bar for its value with + * scaled by the object or applications scaling factor. + * Applications can query the progress bar for its value with * elm_progressbar_value_get(). * * Available widget styles for progress bars: @@ -72,10 +71,10 @@ EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent); * * By default, progress bars will display values from the low to * high value boundaries. There are, though, contexts in which the - * state of progression of a given task is @b unknown. For those, + * progress of a given task is @b unknown. For such cases, * one can set a progress bar widget to a "pulsing state", to give * the user an idea that some computation is being held, but - * without exact progress values. In the default theme it will + * without exact progress values. In the default theme, it will * animate its bar with the contents filling in constantly and back * to non-filled, in a loop. To start and stop this pulsing * animation, one has to explicitly call elm_progressbar_pulse(). diff --git a/src/lib/elm_radio.h b/src/lib/elm_radio.h index 5623d8f..c25fefb 100644 --- a/src/lib/elm_radio.h +++ b/src/lib/elm_radio.h @@ -9,8 +9,15 @@ * * A radio object contains an indicator, an optional Label and an optional * icon object. While it's possible to have a group of only one radio they, - * are normally used in groups of 2 or more. To add a radio to a group use - * elm_radio_group_add(). The radio object(s) will select from one of a set + * are normally used in groups of 2 or more. + * + * elm_radio objects are grouped in a slightly different, compared to other + * UI toolkits. There is no seperate group name/id to remember or manage. + * The members represent the group, there are the group. To make a group, + * use elm_radio_group_add() and pass existing radio object and the new radio + * object. + * + * The radio object(s) will select from one of a set * of integer values, so any value they are configuring needs to be mapped to * a set of integers. To configure what value that radio object represents, * use elm_radio_state_value_set() to set the integer it represents. To set @@ -89,9 +96,9 @@ EAPI void elm_radio_state_value_set(Evas_Object *obj, in EAPI int elm_radio_state_value_get(const Evas_Object *obj); /** - * @brief Set the value of the radio. + * @brief Set the value of the radio group. * - * @param obj The radio object + * @param obj The radio object (any radio object of the group). * @param value The value to use for the group * * This sets the value of the radio group and will also set the value if @@ -100,17 +107,18 @@ EAPI int elm_radio_state_value_get(const Evas_Object *o EAPI void elm_radio_value_set(Evas_Object *obj, int value); /** - * @brief Get the state of the radio object + * @brief Get the value of the radio group * - * @param obj The radio object + * @param obj The radio object (any radio object of the group). * @return The integer state */ EAPI int elm_radio_value_get(const Evas_Object *obj); /** - * @brief Set a convenience pointer to a integer to change + * @brief Set a convenience pointer to a integer to change when radio group + * value changes. * - * @param obj The radio object + * @param obj The radio object (any object of a group) * @param valuep Pointer to the integer to modify * * This sets a pointer to a integer, that, in addition to the radio objects diff --git a/src/lib/elm_scroll.h b/src/lib/elm_scroll.h index 6ab6f8d..ca9aaed 100644 --- a/src/lib/elm_scroll.h +++ b/src/lib/elm_scroll.h @@ -101,7 +101,7 @@ EAPI Eina_Bool elm_object_scroll_lock_x_get(const Evas_Object *obj); /** * Get the scrolling lock of the given widget * - * This gets the lock for X axis scrolling. + * This gets the lock for Y axis scrolling. * * @param obj The object * @ingroup Scrollhints diff --git a/src/lib/elm_segment_control.h b/src/lib/elm_segment_control.h index 061c4e1..c973833 100644 --- a/src/lib/elm_segment_control.h +++ b/src/lib/elm_segment_control.h @@ -274,7 +274,7 @@ EAPI Elm_Object_Item *elm_segment_control_item_selected_get(const Evas_Object *o * @c EINA_TRUE for selected, @c EINA_FALSE for not selected. * * If a new item is selected the previously selected will be unselected. - * Previously selected item can be get with function + * Selected item can be got with function * elm_segment_control_item_selected_get(). * * The selected item always will be highlighted on segment control. -- 2.7.4