From 2bc996b61eea4e1daf5795c29c3c90b78d7aba66 Mon Sep 17 00:00:00 2001 From: Rajeev Ranjan Date: Sun, 10 Oct 2010 18:22:36 +0900 Subject: [PATCH] [elm_button.c, elm_check.c, elm_gridbox.c, elm_panes.c, elm_radio.c, elm_softkey.c, elm_toggle.c] Fixed the direction related input in Doxy --- src/lib/elm_button.c | 36 +++++++++++++++---------------- src/lib/elm_check.c | 24 ++++++++++----------- src/lib/elm_gridbox.c | 28 ++++++++++++------------ src/lib/elm_panes.c | 36 +++++++++++++++---------------- src/lib/elm_radio.c | 32 +++++++++++++-------------- src/lib/elm_softkey.c | 60 +++++++++++++++++++++++++-------------------------- src/lib/elm_toggle.c | 36 +++++++++++++++---------------- 7 files changed, 126 insertions(+), 126 deletions(-) diff --git a/src/lib/elm_button.c b/src/lib/elm_button.c index d1a79e3..0face08 100644 --- a/src/lib/elm_button.c +++ b/src/lib/elm_button.c @@ -298,7 +298,7 @@ _signal_unpressed(void *data, Evas_Object *obj __UNUSED__, const char *emission /** * Add a new button to the parent - * @param parent The parent object + * @param[in] parent The parent object * @return The new object or NULL if it cannot be created * * @ingroup Button @@ -356,8 +356,8 @@ elm_button_add(Evas_Object *parent) /** * Set the label used in the button * - * @param obj The button object - * @param label The text will be written on the button + * @param[in] obj The button object + * @param[in] label The text will be written on the button * * @ingroup Button */ @@ -389,9 +389,9 @@ _set_label(Evas_Object *obj, const char *label) /** * Set the label for each state of button * - * @param obj The button object - * @param label The text will be written on the button - * @param state The state of button + * @param[in] obj The button object + * @param[in] label The text will be written on the button + * @param[in] state The state of button * * @ingroup Button */ @@ -432,7 +432,7 @@ elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlSta /** * Get the label of button * - * @param obj The button object + * @param[in] obj The button object * @return The title of button * * @ingroup Button @@ -448,8 +448,8 @@ elm_button_label_get(const Evas_Object *obj) /** * Get the label of button for each state * - * @param obj The button object - * @param state The state of button + * @param[in] obj The button object + * @param[in] state The state of button * @return The title of button for state * * @ingroup Button @@ -477,8 +477,8 @@ elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) * * Once the icon object is set, a previously set one will be deleted * - * @param obj The button object - * @param icon The image for the button + * @param[in] obj The button object + * @param[in] icon The image for the button * * @ingroup Button */ @@ -506,7 +506,7 @@ elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) /** * Get the icon used for the button * - * @param obj The button object + * @param[in] obj The button object * @return The image for the button * * @ingroup Button @@ -523,8 +523,8 @@ elm_button_icon_get(const Evas_Object *obj) /** * Turn on/off the autorepeat event generated when the user keeps pressing on the button * - * @param obj The button object - * @param on A bool to turn on/off the event + * @param[in] obj The button object + * @param[in] on A bool to turn on/off the event * * @ingroup Button */ @@ -546,8 +546,8 @@ elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) /** * Set the initial timeout before the autorepeat event is generated * - * @param obj The button object - * @param t Timeout + * @param[in] obj The button object + * @param[in] t Timeout * * @ingroup Button */ @@ -569,8 +569,8 @@ elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) /** * Set the interval between each generated autorepeat event * - * @param obj The button object - * @param t Interval + * @param[in] obj The button object + * @param[in] t Interval * * @ingroup Button */ diff --git a/src/lib/elm_check.c b/src/lib/elm_check.c index e49c91d..84b915f 100644 --- a/src/lib/elm_check.c +++ b/src/lib/elm_check.c @@ -171,7 +171,7 @@ _signal_check_toggle(void *data, Evas_Object *obj __UNUSED__, const char *emissi /** * Add a new Check object * - * @param parent The parent object + * @param[in] parent The parent object * @return The new object or NULL if it cannot be created * * @ingroup Check @@ -217,8 +217,8 @@ elm_check_add(Evas_Object *parent) /** * Set the text label of the check object * - * @param obj The check object - * @param label The text label string in UTF-8 + * @param[in] obj The check object + * @param[in] label The text label string in UTF-8 * * @ingroup Check */ @@ -241,7 +241,7 @@ elm_check_label_set(Evas_Object *obj, const char *label) /** * Get the text label of the check object * - * @param obj The check object + * @param[in] obj The check object * @return The text label string in UTF-8 * * @ingroup Check @@ -260,8 +260,8 @@ elm_check_label_get(const Evas_Object *obj) * * Once the icon object is set, a previously set one will be deleted. * - * @param obj The check object - * @param icon The icon object + * @param[in] obj The check object + * @param[in] icon The icon object * * @ingroup Check */ @@ -289,7 +289,7 @@ elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) /** * Get the icon object of the check object * - * @param obj The check object + * @param[in] obj The check object * @return The icon object * * @ingroup Check @@ -309,8 +309,8 @@ elm_check_icon_get(const Evas_Object *obj) * This sets the state of the check and will also set the value if pointed to * to the state supplied, but will not call any callbacks. * - * @param obj The check object - * @param state The state to use (1 == on, 0 == off) + * @param[in] obj The check object + * @param[in] state The state to use (1 == on, 0 == off) * * @ingroup Check */ @@ -334,7 +334,7 @@ elm_check_state_set(Evas_Object *obj, Eina_Bool state) /** * Get the state of the check object * - * @param obj The check object + * @param[in] obj The check object * @return The boolean state * * @ingroup Check @@ -358,8 +358,8 @@ elm_check_state_get(const Evas_Object *obj) * reflect the value of the boolean statep points to, just like calling * elm_check_state_set(). * - * @param obj The check object - * @param statep Pointer to the boolean to modify + * @param[in] obj The check object + * @param[in] statep Pointer to the boolean to modify * * @ingroup Check */ diff --git a/src/lib/elm_gridbox.c b/src/lib/elm_gridbox.c index 72305c5..90552e0 100644 --- a/src/lib/elm_gridbox.c +++ b/src/lib/elm_gridbox.c @@ -182,7 +182,7 @@ _freeze_off(void *data, Evas_Object * obj, void *event_info) /** * Add a new gridbox to the parent * - * @param parent The parent object + * @param[in] parent The parent object * @return The new object or NULL if it cannot be created * * @ingroup Gridbox @@ -233,9 +233,9 @@ elm_gridbox_add(Evas_Object * parent) /** * Set padding between cells. * - * @param obj The layout object. - * @param horizontal set the horizontal padding. - * @param vertical set the vertical padding. + * @param[in] obj The layout object. + * @param[in] horizontal set the horizontal padding. + * @param[in] vertical set the vertical padding. * * @ingroup Gridbox */ @@ -257,9 +257,9 @@ elm_gridbox_padding_set(Evas_Object * obj, Evas_Coord horizontal, /** * Set gridbox item size * - * @param obj The gridbox object - * @param h_pagesize The horizontal item size - * @param v_pagesize The vertical item size + * @param[in] obj The gridbox object + * @param[in] h_pagesize The horizontal item size + * @param[in] v_pagesize The vertical item size * * @ingroup Gridbox */ @@ -297,8 +297,8 @@ elm_gridbox_item_size_set(Evas_Object * obj, Evas_Coord h_itemsize, /** * Add a subobject on the gridbox * - * @param obj The table object - * @param subobj The subobject to be added to the gridbox + * @param[in] obj The table object + * @param[in] subobj The subobject to be added to the gridbox * * @ingroup Gridbox */ @@ -318,8 +318,8 @@ elm_gridbox_pack(Evas_Object * obj, Evas_Object * subobj) /** * Unpack a subobject on the gridbox * - * @param obj The gribox object - * @param subobj The subobject to be removed to the gridbox + * @param[in] obj The gridbox object + * @param[in] subobj The subobject to be removed to the gridbox * * @ingroup Gridbox */ @@ -341,7 +341,7 @@ elm_gridbox_unpack(Evas_Object * obj, Evas_Object * subobj) /** * Get the list of children for the gridbox. * - * @param obj The gribox object + * @param[in] obj The gridbox object * * @ingroup Gridbox */ @@ -360,8 +360,8 @@ elm_gridbox_children_get(Evas_Object * obj) /** * Set homogenous paddding layout * - * @param obj The gribox object - * @param homogenous The homogenous flag (1 = on, 0 = off) + * @param[in] obj The gridbox object + * @param[in] homogenous The homogenous flag (1 = on, 0 = off) * * @ingroup Gridbox */ diff --git a/src/lib/elm_panes.c b/src/lib/elm_panes.c index 6f63cbd..74733cc 100644 --- a/src/lib/elm_panes.c +++ b/src/lib/elm_panes.c @@ -139,7 +139,7 @@ _unpress(void *data, Evas_Object *obj __UNUSED__ , const char *emission __UNUSED /** * Add a new panes to the parent * - * @param parent The parent object + * @param[in] parent The parent object * @return The new object or NULL if it cannot be created * * @ingroup Panes @@ -190,8 +190,8 @@ elm_panes_add(Evas_Object *parent) /** * Set a control as a left/top content of the pane * - * @param obj The pane object - * @param content The object to be set as content + * @param[in] obj The pane object + * @param[in] content The object to be set as content * * @ingroup Panes */ @@ -216,8 +216,8 @@ EAPI void elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) /** * Set a control as a right/bottom content of the pane * - * @param obj The pane object - * @param content The object to be set as content + * @param[in] obj The pane object + * @param[in] content The object to be set as content * * @ingroup Panes */ @@ -243,7 +243,7 @@ EAPI void elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) /** * Get the left/top content of the pane * - * @param obj The pane object + * @param[in] obj The pane object * @return The Evas Object set as a left/top content of the pane * * @ingroup Panes @@ -258,7 +258,7 @@ EAPI Evas_Object /** * Get the right/bottom content of the pane * - * @param obj The pane object + * @param[in] obj The pane object * @return The Evas Object set as a right/bottom content of the pane * * @ingroup Panes @@ -273,7 +273,7 @@ EAPI Evas_Object /** * Unset a control from a left/top content of the pane * - * @param obj The pane object + * @param[in] obj The pane object * @return The content being unset * * @ingroup Panes @@ -300,7 +300,7 @@ elm_panes_content_left_unset(Evas_Object *obj) /** * Unset a control from a right/bottom content of the pane * - * @param obj The pane object + * @param[in] obj The pane object * @return The content being unset * * @ingroup Panes @@ -327,7 +327,7 @@ elm_panes_content_right_unset(Evas_Object *obj) /** * Get the relative normalized size of left/top content of the pane * - * @param obj The pane object + * @param[in] obj The pane object * @return The value of type double in the range [0.0,1.0] * * @ingroup Panes @@ -349,8 +349,8 @@ elm_panes_content_left_size_get(const Evas_Object *obj) /** * Set a size of the left content with a relative normalized double value * - * @param obj The pane object - * @param size The value of type double in the range [0.0,1.0] + * @param[in] obj The pane object + * @param[in] size The value of type double in the range [0.0,1.0] * * @ingroup Panes */ @@ -368,8 +368,8 @@ elm_panes_content_left_size_set(Evas_Object *obj, double size) /** * Set the type of an existing pane object to horizontal/vertical * - * @param obj The pane object - * @param horizontal Boolean value. If true, then the type is set to horizontal else vertical + * @param[in] obj The pane object + * @param[in] horizontal Boolean value. If true, then the type is set to horizontal else vertical * * @ingroup Panes */ @@ -386,7 +386,7 @@ elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) /** * Indicate if the type of pane object is horizontal or not * - * @param obj The pane object + * @param[in] obj The pane object * @return true if it is of horizontal type else false * * @ingroup Panes @@ -402,8 +402,8 @@ elm_panes_horizontal_get(const Evas_Object *obj) /** * Set a handler of the pane object non-movable or movable * - * @param obj The pane object - * @param fixed If set to true then the views size can't be changed using handler otherwise using handler they can be resized + * @param[in] obj The pane object + * @param[in] fixed If set to true then the views size can't be changed using handler otherwise using handler they can be resized * * @ingroup Panes */ @@ -421,7 +421,7 @@ elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) /** * Indicate if the handler of the pane object can be moved with user interaction * - * @param obj The pane object + * @param[in] obj The pane object * @return false if the views can be resized using handler else true * * @ingroup Panes diff --git a/src/lib/elm_radio.c b/src/lib/elm_radio.c index 8955267..e2a65e9 100644 --- a/src/lib/elm_radio.c +++ b/src/lib/elm_radio.c @@ -205,7 +205,7 @@ _signal_radio_on(void *data, Evas_Object *obj __UNUSED__, const char *emission _ /** * Add a new radio to the parent * - * @param parent The parent object + * @param[in] parent The parent object * @return The new object or NULL if it cannot be created * * @ingroup Radio @@ -251,8 +251,8 @@ elm_radio_add(Evas_Object *parent) /** * Set the text label of the radio object * - * @param obj The radio object - * @param label The text label string in UTF-8 + * @param[in] obj The radio object + * @param[in] label The text label string in UTF-8 * * @ingroup Radio */ @@ -280,7 +280,7 @@ elm_radio_label_set(Evas_Object *obj, const char *label) /** * Get the text label of the radio object * - * @param obj The radio object + * @param[in] obj The radio object * @return The text label string in UTF-8 * * @ingroup Radio @@ -299,8 +299,8 @@ elm_radio_label_get(const Evas_Object *obj) * * Once the icon object is set, a previously set one will be deleted. * - * @param obj The radio object - * @param icon The icon object + * @param[in] obj The radio object + * @param[in] icon The icon object * * @ingroup Radio */ @@ -328,7 +328,7 @@ elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) /** * Get the icon object of the radio object * - * @param obj The radio object + * @param[in] obj The radio object * @return The icon object * * @ingroup Radio @@ -350,8 +350,8 @@ elm_radio_icon_get(const Evas_Object *obj) * about eacthother. This adds the given radio object to the group of which * the group object indicated is a member. * - * @param obj The radio object - * @param group The object whose group the object is to join + * @param[in] obj The radio object + * @param[in] group The object whose group the object is to join * * @ingroup Radio */ @@ -387,8 +387,8 @@ elm_radio_group_add(Evas_Object *obj, Evas_Object *group) * * This sets the value of the radio. * - * @param obj The radio object - * @param value The value to use if this radio object is selected + * @param[in] obj The radio object + * @param[in] value The value to use if this radio object is selected * * @ingroup Radio */ @@ -409,8 +409,8 @@ elm_radio_state_value_set(Evas_Object *obj, int value) * This sets the value of the radio group and will also set the value if * pointed to, to the value supplied, but will not call any callbacks. * - * @param obj The radio object - * @param value The value to use for the group + * @param[in] obj The radio object + * @param[in] value The value to use for the group * * @ingroup Radio */ @@ -429,7 +429,7 @@ elm_radio_value_set(Evas_Object *obj, int value) /** * Get the state of the radio object * - * @param obj The radio object + * @param[in] obj The radio object * @return The integer state * * @ingroup Radio @@ -453,8 +453,8 @@ elm_radio_value_get(const Evas_Object *obj) * reflect the value of the integer valuep points to, just like calling * elm_radio_value_set(). * - * @param obj The radio object - * @param valuep Pointer to the integer to modify + * @param[in] obj The radio object + * @param[in] valuep Pointer to the integer to modify * * @ingroup Radio */ diff --git a/src/lib/elm_softkey.c b/src/lib/elm_softkey.c index ea42349..e972396 100644 --- a/src/lib/elm_softkey.c +++ b/src/lib/elm_softkey.c @@ -857,7 +857,7 @@ _softkey_object_hide(void *data, Evas *e, Evas_Object *obj, void *event_info) /** * Add a new softkey to the parent - * @param parent the parent of the smart object + * @param[in] parent the parent of the smart object * @return Evas_Object* pointer of softkey(evas object) or NULL * @ingroup Softkey */ @@ -985,12 +985,12 @@ _softkey_horizontal_set(Evas_Object *obj, Eina_Bool horizontal_mode) /** * add side button of softkey - * @param obj softkey object - * @param type softkey button type - * @param icon The icon object to use for the item - * @param label The text label to use for the item - * @param func Convenience function to call when this item is selected - * @param data Data to pass to convenience function + * @param[in] obj softkey object + * @param[in] type softkey button type + * @param[in] icon The icon object to use for the item + * @param[in] label The text label to use for the item + * @param[in] func Convenience function to call when this item is selected + * @param[in] data Data to pass to convenience function * @return A handle to the item added * * @ingroup Softkey @@ -1083,8 +1083,8 @@ elm_softkey_button_add(Evas_Object *obj, Elm_Softkey_Type type, /** * delete side button of softkey - * @param obj softkey object - * @param type softkey button type + * @param[in] obj softkey object + * @param[in] type softkey button type * * @ingroup Softkey */ @@ -1122,8 +1122,8 @@ elm_softkey_button_del(Evas_Object *obj, Elm_Softkey_Type type) /** * show button of softkey - * @param obj softkey object - * @param type softkey button type + * @param[in] obj softkey object + * @param[in] type softkey button type * * @ingroup Softkey */ @@ -1135,8 +1135,8 @@ elm_softkey_button_show(Evas_Object *obj, Elm_Softkey_Type type) /** * hide button of softkey - * @param obj softkey object - * @param type softkey button type + * @param[in] obj softkey object + * @param[in] type softkey button type * * @ingroup Softkey */ @@ -1148,11 +1148,11 @@ elm_softkey_button_hide(Evas_Object *obj, Elm_Softkey_Type type) /** * add item in panel - * @param obj softkey object - * @param icon The icon object - * @param label The text label to use for the item - * @param func Convenience function to call when this item is selected - * @param data Data to pass to convenience function + * @param[in] obj softkey object + * @param[in] icon The icon object + * @param[in] label The text label to use for the item + * @param[in] func Convenience function to call when this item is selected + * @param[in] data Data to pass to convenience function * @return A handle to the item added * * @ingroup Softkey @@ -1341,7 +1341,7 @@ elm_softkey_panel_item_add(Evas_Object *obj, Evas_Object *icon, /** * delete panel - * @param obj softkey object + * @param[in] obj softkey object * @return int 0 (SUCCESS) or -1 (FAIL) * * @ingroup Softkey @@ -1415,7 +1415,7 @@ elm_softkey_panel_del(Evas_Object *obj) /** * sliding up panel if it is closed - * @param obj softkey object + * @param[in] obj softkey object * @return int 0 (SUCCESS) or -1 (FAIL) * * @ingroup Softkey @@ -1440,7 +1440,7 @@ elm_softkey_panel_open(Evas_Object *obj) /** * sliding down panel if it is opened - * @param obj softkey object + * @param[in] obj softkey object * @return int 0 (SUCCESS) or -1 (FAIL) * * @ingroup Softkey @@ -1465,8 +1465,8 @@ elm_softkey_panel_close(Evas_Object *obj) /** * Set the icon of an softkey item * - * @param it The item to set the icon - * @param icon The icon object + * @param[in] it The item to set the icon + * @param[in] icon The icon object * * @ingroup Softkey */ @@ -1498,7 +1498,7 @@ elm_softkey_item_icon_set(Elm_Softkey_Item *it, Evas_Object *icon) /** * Get the icon of an softkey item * - * @param it The item to get the icon + * @param[in] it The item to get the icon * @return The icon object * * @ingroup Softkey @@ -1513,8 +1513,8 @@ elm_softkey_item_icon_get(Elm_Softkey_Item *it) /** * Get the text label of an softkey item * - * @param it The item to set the label - * @param label label + * @param[in] it The item to set the label + * @param[in] label label * * @ingroup Softkey */ @@ -1544,9 +1544,9 @@ elm_softkey_item_label_set(Elm_Softkey_Item *it, const char *label) /** * Set the item callback function * - * @param it Item to set callback function. - * @param func callback function pointer. - * @param data callback function argument data. + * @param[in] it Item to set callback function. + * @param[in] func callback function pointer. + * @param[in] data callback function argument data. * * @ingroup Softkey */ @@ -1564,7 +1564,7 @@ elm_softkey_item_callback_set(Elm_Softkey_Item* item, void /** * Get the text label of an softkey item * - * @param it The item to get the label + * @param[in] it The item to get the label * @return The text label of the softkey item * * @ingroup Softkey diff --git a/src/lib/elm_toggle.c b/src/lib/elm_toggle.c index f85d5a4..3a7b479 100644 --- a/src/lib/elm_toggle.c +++ b/src/lib/elm_toggle.c @@ -154,7 +154,7 @@ _signal_toggle_on(void *data, Evas_Object *obj __UNUSED__, const char *emission /** * Add a toggle to @p parent. * - * @param parent The parent object + * @param[in] parent The parent object * * @return The toggle object * @@ -203,8 +203,8 @@ elm_toggle_add(Evas_Object *parent) /** * Sets the label to be displayed with the toggle. * - * @param obj The toggle object - * @param label The label to be displayed + * @param[in] obj The toggle object + * @param[in] label The label to be displayed * * @ingroup Toggle */ @@ -227,7 +227,7 @@ elm_toggle_label_set(Evas_Object *obj, const char *label) /** * Gets the label of the toggle * - * @param obj The toggle object + * @param[in] obj The toggle object * @return The label of the toggle * * @ingroup Toggle @@ -246,8 +246,8 @@ elm_toggle_label_get(const Evas_Object *obj) * * Once the icon object is set, a previously set one will be deleted. * - * @param obj The toggle object - * @param icon The icon object to be displayed + * @param[in] obj The toggle object + * @param[in] icon The icon object to be displayed * * @ingroup Toggle */ @@ -275,7 +275,7 @@ elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) /** * Gets the icon of the toggle * - * @param obj The toggle object + * @param[in] obj The toggle object * @return The icon object * * @ingroup Toggle @@ -292,9 +292,9 @@ elm_toggle_icon_get(const Evas_Object *obj) /** * Sets the labels to be associated with the on and off states of the toggle. * - * @param obj The toggle object - * @param onlabel The label displayed when the toggle is in the "on" state - * @param offlabel The label displayed when the toggle is in the "off" state + * @param[in] obj The toggle object + * @param[in] onlabel The label displayed when the toggle is in the "on" state + * @param[in] offlabel The label displayed when the toggle is in the "off" state * * @ingroup Toggle */ @@ -315,9 +315,9 @@ elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char * /** * Gets the labels associated with the on and off states of the toggle. * - * @param obj The toggle object - * @param onlabel A char** to place the onlabel of @p obj into - * @param offlabel A char** to place the offlabel of @p obj into + * @param[in] obj The toggle object + * @param[in] onlabel A char** to place the onlabel of @p obj into + * @param[in] offlabel A char** to place the offlabel of @p obj into * * @ingroup Toggle */ @@ -336,8 +336,8 @@ elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const /** * Sets the state of the toggle to @p state. * - * @param obj The toggle object - * @param state The state of @p obj + * @param[in] obj The toggle object + * @param[in] state The state of @p obj * * @ingroup Toggle */ @@ -361,7 +361,7 @@ elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) /** * Gets the state of the toggle to @p state. * - * @param obj The toggle object + * @param[in] obj The toggle object * @return The state of @p obj * * @ingroup Toggle @@ -378,8 +378,8 @@ elm_toggle_state_get(const Evas_Object *obj) /** * Sets the state pointer of the toggle to @p statep. * - * @param obj The toggle object - * @param statep The state pointer of @p obj + * @param[in] obj The toggle object + * @param[in] statep The state pointer of @p obj * * @ingroup Toggle */ -- 2.7.4