kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: fix mismatched variable names between prototypes and doxygen comments. 

Several APIs are marked as not documented simply because the doxygen
documentation mentions a parameter named "foo" while the spelling in the
prototype is something like "fooh". An example correction is
  - * @param fsize Finger size
  + * @param sz Finger size

Nothing very complicated and there are also a couple typo fixes I noticed
while going over the files.
This commit is contained in:
Adrien Nader 2014-10-13 14:50:22 +02:00 committed by Cedric BAIL
parent b12c544d21
commit bfd57b3d84
11 changed files with 27 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
legacy/elementary/src/lib/elc_fileselector_legacy.h
View File

@ -408,6 +408,6 @@ EAPI Elm_Fileselector_Sort elm_fileselector_sort_method_get(const Evas_Object *o
* @since 1.9
* @ingroup Fileselector
*/
EAPI void elm_fileselector_sort_method_set(Evas_Object *obj, Elm_Fileselector_Sort method);
EAPI void elm_fileselector_sort_method_set(Evas_Object *obj, Elm_Fileselector_Sort sort);
#include "elm_fileselector.eo.legacy.h"

1
legacy/elementary/src/lib/elc_naviframe_common.h
View File

@ -109,6 +109,7 @@ EAPI Eina_Bool elm_naviframe_item_title_enabled_get(const Elm_Object_Item
*
* @param it The item to set the callback on
* @param func the callback function.
* @param data The data to be passed to this @p func call.
*
* @warning Don't set "clicked" callback to the prev button additionally if the
* function does an exact same logic with this @c func. When hardware back key

2
legacy/elementary/src/lib/elm_actionslider.eo
View File

@ -25,7 +25,7 @@ class Elm_Actionslider (Elm_Layout)
set {
/*@
Set actionslider magnet position. To make multiple positions magnets @c or
them together(e.g.: #ELM_ACTIONSLIDER_LEFT | #ELM_ACTIONSLIDER_RIGHT)
them together (e.g. #ELM_ACTIONSLIDER_LEFT | #ELM_ACTIONSLIDER_RIGHT)
@ingroup Actionslider */
}

4
legacy/elementary/src/lib/elm_app_client.eo
View File

@ -8,7 +8,7 @@ class Elm_App_Client (Eo.Base)
/*@ Return a iterator with all views of application. */
}
values {
iterator *ret; /*@ the iterator with all views, must be freed after use */
iterator *ret; /*@ The iterator with all views, must be freed after use */
}
}
package {
@ -35,7 +35,7 @@ class Elm_App_Client (Eo.Base)
/*@ Terminate application. */
}
view_open {
/*@ Open a application view. */
/*@ Open an application view. */
params {
@in Eina_Value *args; /*@ an array of */
@in Elm_App_Client_Open_View_Cb view_open_cb; /*@ callback to be called when view open */

16
legacy/elementary/src/lib/elm_config.h
View File

@ -430,7 +430,7 @@ EAPI double elm_config_scroll_thumbscroll_friction_standard_get(void);
* same with thumbscroll friction, if the velocity is same with standard
* velocity.
*
* @param friction the thumb scroll friction standard
* @param standard the thumb scroll friction standard
*
* @see elm_config_thumbscroll_friction_standard_get()
* @ingroup Scrolling
@ -524,7 +524,7 @@ EAPI double elm_config_scroll_thumbscroll_acceleration_time_limit_get(void
/**
* Set the time limit for accelerating velocity.
*
* @param threshold the thumb scroll acceleration time limit
* @param time_limit the thumb scroll acceleration time limit
*
* @see elm_config_thumbscroll_acceleration_time_limit_get()
* @ingroup Scrolling
@ -543,7 +543,7 @@ EAPI double elm_config_scroll_thumbscroll_acceleration_weight_get(void);
/**
* Set the weight for the acceleration.
*
* @param threshold the thumb scroll acceleration weight
* @param weight the thumb scroll acceleration weight
*
* @see elm_config_thumbscroll_acceleration_weight_get()
* @ingroup Scrolling
@ -960,7 +960,7 @@ EAPI Eina_Bool elm_config_access_get(void);
/**
* Set access mode
*
* @param is_accesss If @c EINA_TRUE, enables access mode
* @param is_access If @c EINA_TRUE, enables access mode
*
* @note Elementary objects may have information (e.g. label on the elm_button)
* to be read. This information is read by access module when an object
@ -1377,13 +1377,13 @@ EAPI Eina_Bool elm_config_item_select_on_focus_disabled_get(void);
/**
* Set the disable status of the item select on focus feature.
*
* @param disable Disable item select on focus if @c EINA_TRUE, enable otherwise
* @param disabled Disable item select on focus if @c EINA_TRUE, enable otherwise
*
* @see elm_config_item_select_on_focus_disabled_get
* @since 1.10
* @ingroup Focus
*/
EAPI void elm_config_item_select_on_focus_disabled_set(Eina_Bool enabled);
EAPI void elm_config_item_select_on_focus_disabled_set(Eina_Bool disabled);
/**
* Get status of first item focus on first focusin feature.
@ -1399,7 +1399,7 @@ EAPI Eina_Bool elm_config_first_item_focus_on_first_focusin_get(void);
/**
* Set the first item focus on first focusin feature.
*
* @param enable first_item_focus_on_first_focusin if @c EINA_TRUE, enable otherwise
* @param enabled first_item_focus_on_first_focusin if @c EINA_TRUE, enable otherwise
*
* @see elm_config_first_item_focus_on_first_focusin_get
* @since 1.11
@ -1483,7 +1483,7 @@ EAPI double elm_config_glayer_double_tap_timeout_get(void);
/**
* Set the duration for occurring double tap event of gesture layer.
*
* @param long_tap_timeout Timeout for double tap event of gesture layer.
* @param double_tap_timeout Timeout for double tap event of gesture layer.
* @ingroup Elm_Gesture_Layer
* @since 1.8
*/

2
legacy/elementary/src/lib/elm_gesture_layer_common.h
View File

@ -434,7 +434,7 @@ EAPI double elm_gesture_layer_double_tap_timeout_get(const Evas_Object *obj);
* Set to ZERO if you want GLayer to use system finger size value (default)
*
* @param obj gesture-layer.
* @param fsize Finger size
* @param sz Finger size
*
* @since 1.8
* @ingroup Elm_Gesture_Layer

4
legacy/elementary/src/lib/elm_map_common.h
View File

@ -509,10 +509,10 @@ EAPI void elm_map_overlays_show(Eina_List *overlays);
EAPI void elm_map_overlay_get_cb_set(Elm_Map_Overlay *overlay, Elm_Map_Overlay_Get_Cb get_cb, void *data);
/**
* Set the get callback function to call when the overlay is deleted.
* Set the del callback function to call when the overlay is deleted.
*
* @param overlay The overlay to own the del callback function.
* @param get_cb The callback function.
* @param del_cb The callback function.
* @param data The user callback data.
*
* If the overlay is deleted, the callback wll be called.

6
legacy/elementary/src/lib/elm_prefs_data.h
View File

@ -181,7 +181,7 @@ EAPI void elm_prefs_data_unref(Elm_Prefs_Data *prefs_data);
* Set (or delete) one value of a given prefs data handle.
*
* @param prefs_data A valid prefs data handle
* @param name The (unique) name (key) of the given value
* @param path The (unique) name (key) of the given value
* @param type The item type to which the value is to be associated
* @param value The value, itself. It must be a valid @c Eina_Value
* handle, bound to a given type and value or @c NULL. On
@ -204,7 +204,7 @@ EAPI Eina_Bool elm_prefs_data_value_set(Elm_Prefs_Data *prefs_data,
* Retrieve one value of a given prefs data handle (by key).
*
* @param prefs_data A valid prefs data handle
* @param name The (unique) name (key) of the given value
* @param path The (unique) name (key) of the given value
* @param type The item type associated with the value
* @param value A valid @c Eina_Value handle, where to store the
* value, itself.
@ -258,7 +258,7 @@ EAPI Eina_Bool elm_prefs_data_event_callback_add(Elm_Prefs_Data *prefs_dat
* @since 1.8
*/
EAPI Eina_Bool elm_prefs_data_event_callback_del(Elm_Prefs_Data *prefs_data,
Elm_Prefs_Data_Event_Type t,
Elm_Prefs_Data_Event_Type type,
Elm_Prefs_Data_Event_Cb cb,
const void *cb_data);

6
legacy/elementary/src/lib/elm_toolbar_common.h
View File

@ -420,23 +420,25 @@ EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *i
* Show a specific item, when the toolbar can be scrolled.
*
* @param it the toolbar item
* @param scrollto the position the item should appear at
*
* see elm_toolbar_item_bring_in()
*
* @since 1.8
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_show(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type type);
EAPI void elm_toolbar_item_show(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type scrollto);
/**
* Show a specific item with scroll animation, when the toolbar can be scrolled.
*
* @param it the toolbar item
* @param scrollto the position the item should appear at
*
* see elm_toolbar_item_show()
*
* @since 1.8
* @ingroup Toolbar
*/
EAPI void elm_toolbar_item_bring_in(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type type);
EAPI void elm_toolbar_item_bring_in(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type scrollto);

6
legacy/elementary/src/lib/elm_transit.h
View File

@ -633,7 +633,7 @@ EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *tr
/**
* Set the smooth effect for a transit.
*
* @param obj The transit object
* @param transit The transit object
* @param enabled enable or disable smooth map rendering
*
* This sets smoothing for transit map rendering. If the object added in a
@ -646,14 +646,14 @@ EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *tr
*
* @ingroup Transit
*/
EAPI void elm_transit_smooth_set(Elm_Transit *transit, Eina_Bool smooth);
EAPI void elm_transit_smooth_set(Elm_Transit *transit, Eina_Bool enabled);
/**
* Get the smooth scaling for transit map rendering
*
* This gets smooth scaling for transit map rendering.
*
* @param obj The transit object
* @param transit The transit object
* @return @c EINA_TRUE if the smooth is enabled, @c EINA_FALSE otherwise.
*
* @see elm_transit_smooth_set()

2
legacy/elementary/src/lib/elm_win.eo
View File

@ -134,7 +134,7 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window,
}
values {
int *rotations @const_set; /*@ The array of rotation value. */
uint count; /*@ The number of array of rotations */
uint count; /*@ The size of the @param rotations array. */
}
}
quickpanel_zone {