seoz pushed a commit to branch master. http://git.enlightenment.org/core/elementary.git/commit/?id=deea7307b4da6fa4eaed1a8cf2f7a0bc947eb989
commit deea7307b4da6fa4eaed1a8cf2f7a0bc947eb989 Author: Daniel Juyung Seo <[email protected]> Date: Sun Jul 20 01:50:03 2014 +0900 elm: use @p for parameters in doxygen. --- src/lib/elc_fileselector.h | 6 +++--- src/lib/elc_fileselector_button.h | 4 ++-- src/lib/elc_fileselector_entry.h | 2 +- src/lib/elm_check.h | 3 ++- src/lib/elm_entry.h | 2 +- src/lib/elm_gengrid.h | 14 +++++++------- src/lib/elm_gengrid_common.h | 2 +- src/lib/elm_genlist.h | 6 +++--- src/lib/elm_genlist_common.h | 2 +- src/lib/elm_index.h | 4 ++-- src/lib/elm_list.h | 4 ++-- src/lib/elm_object.h | 2 +- src/lib/elm_object_item.h | 2 +- src/lib/elm_panel.h | 2 +- src/lib/elm_removed.h | 8 ++++---- src/lib/elm_tooltip.h | 2 +- src/lib/elm_web_common.h | 4 ++-- 17 files changed, 35 insertions(+), 34 deletions(-) diff --git a/src/lib/elc_fileselector.h b/src/lib/elc_fileselector.h index 4da2aec..9ecd561 100644 --- a/src/lib/elc_fileselector.h +++ b/src/lib/elc_fileselector.h @@ -40,17 +40,17 @@ * This widget emits the following signals, besides the ones sent from * @ref Layout: * - @c "activated" - the user activated a file. This can happen by - * double-clicking or pressing Enter key. (@c event_info is a + * double-clicking or pressing Enter key. (@p event_info is a * pointer to the activated file path) * - @c "selected" - the user has clicked on a file (when not in * folders-only mode) or directory (when in folders-only mode) * - @c "selected,invalid" - the user has tried to access wrong path * which does not exist. * - @c "directory,open" - the list has been populated with new - * content (@c event_info is a pointer to the directory's + * content (@p event_info is a pointer to the directory's * path, a @b stringshared string) * - @c "done" - the user has clicked on the "ok" or "cancel" - * buttons (@c event_info is a pointer to the selection's + * buttons (@p event_info is a pointer to the selection's * path, a @b stringshared string) * - @c "focused" - When the fileselector has received focus. (since 1.9) * - @c "unfocused" - When the fileselector has lost focus. (since 1.9) diff --git a/src/lib/elc_fileselector_button.h b/src/lib/elc_fileselector_button.h index d7d485f..608b2f4 100644 --- a/src/lib/elc_fileselector_button.h +++ b/src/lib/elc_fileselector_button.h @@ -16,7 +16,7 @@ * window (or inner window) <b> with a @ref Fileselector "file * selector widget" within</b>. When a file is chosen, the (inner) * window is closed and the button emits a signal having the - * selected file as it's @c event_info. + * selected file as it's @p event_info. * * This widget encapsulates operations on its internal file * selector on its own API. There is less control over its file @@ -34,7 +34,7 @@ * This widget emits the following signals, besides the ones sent from * @ref Button: * - @c "file,chosen" - the user has selected a path, whose string - * pointer comes as the @c event_info data (a stringshared + * pointer comes as the @p event_info data (a stringshared * string) * - @c "language,changed" - the program's language changed * - @c "focused" - When the fileselector button has received focus. (since 1.8) diff --git a/src/lib/elc_fileselector_entry.h b/src/lib/elc_fileselector_entry.h index a360ce5..c6abdd1 100644 --- a/src/lib/elc_fileselector_entry.h +++ b/src/lib/elc_fileselector_entry.h @@ -47,7 +47,7 @@ * after being pressed. * - @c "file,chosen" - The user has selected a path via the file * selector entry's internal file selector, whose string pointer - * comes as the @c event_info data (a stringshared string) + * comes as the @p event_info data (a stringshared string) * - @c "language,changed" - the program's language changed * * Default text parts of the fileselector_button widget that you can use for diff --git a/src/lib/elm_check.h b/src/lib/elm_check.h index 2451b53..ba254c4 100644 --- a/src/lib/elm_check.h +++ b/src/lib/elm_check.h @@ -1,4 +1,5 @@ /** +kkikk * @defgroup Check Check * @ingroup Elementary * @@ -29,7 +30,7 @@ * This widget emits the following signals, besides the ones sent from * @ref Layout: * - @c "changed" - This is called whenever the user changes the state of - * the check objects (@c event_info is always @c NULL). + * the check objects (@p event_info is always @c NULL). * - @c "focused" - When the check has received focus. (since 1.8) * - @c "unfocused" - When the check has lost focus. (since 1.8) * - @c "language,changed" - the program's language changed (since 1.9) diff --git a/src/lib/elm_entry.h b/src/lib/elm_entry.h index fa36815..a85e840 100644 --- a/src/lib/elm_entry.h +++ b/src/lib/elm_entry.h @@ -101,7 +101,7 @@ * used to identify the anchor and it can be any valid utf8 string. * * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with - * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the + * an #Elm_Entry_Anchor_Info in the @p event_info parameter for the * callback function. The same applies for "anchor,in" (mouse in), "anchor,out" * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on * an anchor. diff --git a/src/lib/elm_gengrid.h b/src/lib/elm_gengrid.h index aa5522b..7568145 100644 --- a/src/lib/elm_gengrid.h +++ b/src/lib/elm_gengrid.h @@ -164,25 +164,25 @@ * This widget emits the following signals, besides the ones sent from * @ref Layout: * - @c "activated" - The user has double-clicked or pressed - * (enter|return|spacebar) on an item. The @c event_info parameter + * (enter|return|spacebar) on an item. The @p event_info parameter * is the gengrid item that was activated. - * - @c "pressed" - The user pressed the an item. The @c event_info + * - @c "pressed" - The user pressed the an item. The @p event_info * parameter is the item that was pressed. - * - @c "released" - The user released the an item. The @c event_info + * - @c "released" - The user released the an item. The @p event_info * parameter is the item that was released. * - @c "clicked,double" - The user has double-clicked an item. - * The @c event_info parameter is the gengrid item that was double-clicked. + * The @p event_info parameter is the gengrid item that was double-clicked. * - @c "longpressed" - This is called when the item is pressed for a certain * amount of time. By default it's 1 second. * - @c "selected" - The user has made an item selected. The - * @c event_info parameter is the gengrid item that was selected. + * @p event_info parameter is the gengrid item that was selected. * - @c "unselected" - The user has made an item unselected. The - * @c event_info parameter is the gengrid item that was unselected. + * @p event_info parameter is the gengrid item that was unselected. * - @c "realized" - This is called when the item in the gengrid * has its implementing Evas object instantiated, de facto. @c * event_info is the gengrid item that was created. * - @c "unrealized" - This is called when the implementing Evas - * object for this item is deleted. @c event_info is the gengrid + * object for this item is deleted. @p event_info is the gengrid * item that was deleted. * - @c "changed" - Called when an item is added, removed, resized * or moved and when the gengrid is resized or gets "horizontal" diff --git a/src/lib/elm_gengrid_common.h b/src/lib/elm_gengrid_common.h index be77038..ae13701 100644 --- a/src/lib/elm_gengrid_common.h +++ b/src/lib/elm_gengrid_common.h @@ -282,7 +282,7 @@ EAPI void elm_gengrid_item_tooltip_text_set(Elm_Object_ * another callback replaces @p func, the tooltip is unset with * elm_gengrid_item_tooltip_unset() or the owner @p item * dies. This callback receives as its first parameter the - * given @p data, being @c event_info the item handle. + * given @p data, being @p event_info the item handle. * * This call will setup the tooltip's contents to @p item * (analogous to elm_object_tooltip_content_cb_set(), but being diff --git a/src/lib/elm_genlist.h b/src/lib/elm_genlist.h index aca51fb..676ef03 100644 --- a/src/lib/elm_genlist.h +++ b/src/lib/elm_genlist.h @@ -270,11 +270,11 @@ * This widget emits the following signals, besides the ones sent from * @ref Layout: * - @c "activated" - The user has double-clicked or pressed - * (enter|return|spacebar) on an item. The @c event_info parameter is the + * (enter|return|spacebar) on an item. The @p event_info parameter is the * item that was activated. - * - @c "pressed" - The user pressed the an item. The @c event_info + * - @c "pressed" - The user pressed the an item. The @p event_info * parameter is the item that was pressed. - * - @c "released" - The user released the an item. The @c event_info + * - @c "released" - The user released the an item. The @p event_info * parameter is the item that was released. * - @c "clicked,double" - The user has double-clicked an item. The @c * event_info parameter is the item that was double-clicked. diff --git a/src/lib/elm_genlist_common.h b/src/lib/elm_genlist_common.h index 069a70b..4fe6d4a 100644 --- a/src/lib/elm_genlist_common.h +++ b/src/lib/elm_genlist_common.h @@ -319,7 +319,7 @@ EAPI void elm_genlist_item_tooltip_text_set(Elm_Object_ * another callback replaces @p func, the tooltip is unset with * elm_genlist_item_tooltip_unset() or the owner @p item * dies. This callback receives as its first parameter the - * given @p data, being @c event_info the item handle. + * given @p data, being @p event_info the item handle. * * This call will setup the tooltip's contents to @p item * (analogous to elm_object_tooltip_content_cb_set(), but being diff --git a/src/lib/elm_index.h b/src/lib/elm_index.h index 0035f64..afd7229 100644 --- a/src/lib/elm_index.h +++ b/src/lib/elm_index.h @@ -32,10 +32,10 @@ * - @c "changed" - When the selected index item changes. @c * event_info is the selected item's data pointer. * - @c "delay,changed" - When the selected index item changes, but - * after a small idling period. @c event_info is the selected + * after a small idling period. @p event_info is the selected * item's data pointer. * - @c "selected" - When the user releases a mouse button and - * selects an item. @c event_info is the selected item's pointer. + * selects an item. @p event_info is the selected item's pointer. * - @c "level,up" - when the user moves a finger from the first * level to the second level * - @c "level,down" - when the user moves a finger from the second diff --git a/src/lib/elm_list.h b/src/lib/elm_list.h index 5793ae6..011fa5a 100644 --- a/src/lib/elm_list.h +++ b/src/lib/elm_list.h @@ -25,10 +25,10 @@ * This widget emits the following signals, besides the ones sent from * @ref Layout: * - @c "activated" - The user has double-clicked or pressed - * (enter|return|spacebar) on an item. The @c event_info parameter + * (enter|return|spacebar) on an item. The @p event_info parameter * is the item that was activated. * - @c "clicked,double" - The user has double-clicked an item. - * The @c event_info parameter is the item that was double-clicked. + * The @p event_info parameter is the item that was double-clicked. * - @c "selected" - when the user selected an item * - @c "unselected" - when the user unselected an item * - @c "longpressed" - an item in the list is long-pressed diff --git a/src/lib/elm_object.h b/src/lib/elm_object.h index 4e8048f..2efb3e2 100644 --- a/src/lib/elm_object.h +++ b/src/lib/elm_object.h @@ -417,7 +417,7 @@ EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *e * these event upwards in the tree of widgets to @b cease: * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean * the event was @b not processed, so the propagation will go on. - * - The @c event_info pointer passed to @p func will contain the + * - The @p event_info pointer passed to @p func will contain the * event's structure and, if you OR its @c event_flags inner * value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary * one has already handled it, thus killing the event's diff --git a/src/lib/elm_object_item.h b/src/lib/elm_object_item.h index 10f3c01..c0884af 100644 --- a/src/lib/elm_object_item.h +++ b/src/lib/elm_object_item.h @@ -467,7 +467,7 @@ EAPI Eina_Bool elm_object_item_tooltip_window_mode_get(const * another callback replaces @a func, the tooltip is unset with * elm_object_item_tooltip_unset() or the owner @a item * dies. This callback receives as the first parameter the - * given @a data, and @c event_info is the item. + * given @a data, and @p event_info is the item. * * @see elm_object_tooltip_content_cb_set() for more details. * diff --git a/src/lib/elm_panel.h b/src/lib/elm_panel.h index 0e957ee..ebbe92e 100644 --- a/src/lib/elm_panel.h +++ b/src/lib/elm_panel.h @@ -25,7 +25,7 @@ * @ref Layout: * @li @c "scroll" : When the content has been scrolled (moved). (since 1.10) * This signal is emitted only when the panel is scrollable. - * Elm_Panel_Scroll_Info will be passed by @c event_info argument. + * Elm_Panel_Scroll_Info will be passed by @p event_info argument. * @li @c "focused" : When the panel has received focus. (since 1.8) * @li @c "unfocused" : When the panel has lost focus. (since 1.8) * diff --git a/src/lib/elm_removed.h b/src/lib/elm_removed.h index a1ea576..f1232ae 100644 --- a/src/lib/elm_removed.h +++ b/src/lib/elm_removed.h @@ -1743,7 +1743,7 @@ EINA_DEPRECATED EAPI void elm_diskselector_item_tooltip_text_s * another callback replaces @p func, the tooltip is unset with * elm_diskselector_item_tooltip_unset() or the owner @a item * dies. This callback receives as the first parameter the - * given @a data, and @c event_info is the item. + * given @a data, and @p event_info is the item. * * @deprecated Use elm_object_item_tooltip_content_cb_set() instead * @see elm_object_tooltip_content_cb_set() for more details. @@ -2336,7 +2336,7 @@ EINA_DEPRECATED EAPI void elm_index_item_data_set(Elm_Object_Item *it, const vo * @param it The item to set the callback on * @param func The function to call on the item's deletion * - * When called, @p func will have both @c data and @c event_info + * When called, @p func will have both @c data and @p event_info * arguments with the @p it item's data value and, naturally, the * @c obj argument with a handle to the parent index widget. * @@ -3372,7 +3372,7 @@ EINA_DEPRECATED EAPI void elm_toolbar_item_del(Elm_Objec * another callback replaces @a func, the tooltip is unset with * elm_toolbar_item_tooltip_unset() or the owner @a item * dies. This callback receives as the first parameter the - * given @a data, and @c event_info is the item. + * given @a data, and @p event_info is the item. * * @deprecated Use elm_object_item_tooltip_content_cb_set() instead * @see elm_object_tooltip_content_cb_set() for more details. @@ -3959,7 +3959,7 @@ EINA_DEPRECATED EAPI void elm_list_item_tooltip_text_set * another callback replaces @a func, the tooltip is unset with * elm_list_item_tooltip_unset() or the owner @a item * dies. This callback receives as the first parameter the - * given @a data, and @c event_info is the item. + * given @a data, and @p event_info is the item. * * @deprecated Use elm_object_item_tooltip_content_cb_set() instead * diff --git a/src/lib/elm_tooltip.h b/src/lib/elm_tooltip.h index d1b6d4d..9be3a98 100644 --- a/src/lib/elm_tooltip.h +++ b/src/lib/elm_tooltip.h @@ -164,7 +164,7 @@ EAPI void elm_object_tooltip_domain_translatable_text_set(Evas_Object *ob * another callback replaces @p func, the tooltip is unset with * elm_object_tooltip_unset() or the owner object @a obj * dies. This callback receives as the first parameter the - * given @a data, and @c event_info is NULL. + * given @a data, and @p event_info is NULL. * * Setup the tooltip to object. The object can have only one tooltip, * so any previous tooltip data is removed. @p func(with @p data) will diff --git a/src/lib/elm_web_common.h b/src/lib/elm_web_common.h index 0436bb4..ee57863 100644 --- a/src/lib/elm_web_common.h +++ b/src/lib/elm_web_common.h @@ -57,7 +57,7 @@ struct _Elm_Web_Menu_Item /** * Structure describing the menu of a popup * - * This structure will be passed as the @c event_info for the "popup,create" + * This structure will be passed as the @p event_info for the "popup,create" * signal, which is emitted when a dropdown menu is opened. Users wanting * to handle these popups by themselves should listen to this signal and * set the @c handled property of the struct to @c EINA_TRUE. Leaving this @@ -78,7 +78,7 @@ typedef struct _Elm_Web_Menu Elm_Web_Menu; /** * Structure describing the menu of a popup * - * This structure will be passed as the @c event_info for the "popup,create" + * This structure will be passed as the @p event_info for the "popup,create" * signal, which is emitted when a dropdown menu is opened. Users wanting * to handle these popups by themselves should listen to this signal and * set the @c handled property of the struct to @c EINA_TRUE. Leaving this --
