summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrien Nader <adrien@notk.org>2014-10-13 14:50:22 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:42:21 +0200
commit5bbf974060a09e15237eb9521a345adad922ea61 (patch)
tree993ee3d1d96c87d65b14c97c103368ded683fac5
parent49179a03878256b1f09ea0622d404de73d792b1c (diff)
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.
-rw-r--r--src/lib/elc_fileselector_legacy.h2
-rw-r--r--src/lib/elc_naviframe_common.h1
-rw-r--r--src/lib/elm_actionslider.eo2
-rw-r--r--src/lib/elm_app_client.eo4
-rw-r--r--src/lib/elm_config.h16
-rw-r--r--src/lib/elm_gesture_layer_common.h2
-rw-r--r--src/lib/elm_map_common.h4
-rw-r--r--src/lib/elm_prefs_data.h6
-rw-r--r--src/lib/elm_toolbar_common.h6
-rw-r--r--src/lib/elm_transit.h6
-rw-r--r--src/lib/elm_win.eo2
11 files changed, 27 insertions, 24 deletions
diff --git a/src/lib/elc_fileselector_legacy.h b/src/lib/elc_fileselector_legacy.h
index 2c7fcd6a5..0aa5b7949 100644
--- a/src/lib/elc_fileselector_legacy.h
+++ b/src/lib/elc_fileselector_legacy.h
@@ -408,6 +408,6 @@ EAPI Elm_Fileselector_Sort elm_fileselector_sort_method_get(const Evas_Object *o
408 * @since 1.9 408 * @since 1.9
409 * @ingroup Fileselector 409 * @ingroup Fileselector
410 */ 410 */
411EAPI void elm_fileselector_sort_method_set(Evas_Object *obj, Elm_Fileselector_Sort method); 411EAPI void elm_fileselector_sort_method_set(Evas_Object *obj, Elm_Fileselector_Sort sort);
412 412
413#include "elm_fileselector.eo.legacy.h" 413#include "elm_fileselector.eo.legacy.h"
diff --git a/src/lib/elc_naviframe_common.h b/src/lib/elc_naviframe_common.h
index 757bdb551..39d3a79e2 100644
--- a/src/lib/elc_naviframe_common.h
+++ b/src/lib/elc_naviframe_common.h
@@ -109,6 +109,7 @@ EAPI Eina_Bool elm_naviframe_item_title_enabled_get(const Elm_Object_Item
109 * 109 *
110 * @param it The item to set the callback on 110 * @param it The item to set the callback on
111 * @param func the callback function. 111 * @param func the callback function.
112 * @param data The data to be passed to this @p func call.
112 * 113 *
113 * @warning Don't set "clicked" callback to the prev button additionally if the 114 * @warning Don't set "clicked" callback to the prev button additionally if the
114 * function does an exact same logic with this @c func. When hardware back key 115 * function does an exact same logic with this @c func. When hardware back key
diff --git a/src/lib/elm_actionslider.eo b/src/lib/elm_actionslider.eo
index 27d74ea2e..84f42d76e 100644
--- a/src/lib/elm_actionslider.eo
+++ b/src/lib/elm_actionslider.eo
@@ -25,7 +25,7 @@ class Elm_Actionslider (Elm_Layout)
25 set { 25 set {
26 /*@ 26 /*@
27 Set actionslider magnet position. To make multiple positions magnets @c or 27 Set actionslider magnet position. To make multiple positions magnets @c or
28 them together(e.g.: #ELM_ACTIONSLIDER_LEFT | #ELM_ACTIONSLIDER_RIGHT) 28 them together (e.g. #ELM_ACTIONSLIDER_LEFT | #ELM_ACTIONSLIDER_RIGHT)
29 29
30 @ingroup Actionslider */ 30 @ingroup Actionslider */
31 } 31 }
diff --git a/src/lib/elm_app_client.eo b/src/lib/elm_app_client.eo
index c2b4bdd1e..65661581e 100644
--- a/src/lib/elm_app_client.eo
+++ b/src/lib/elm_app_client.eo
@@ -8,7 +8,7 @@ class Elm_App_Client (Eo.Base)
8 /*@ Return a iterator with all views of application. */ 8 /*@ Return a iterator with all views of application. */
9 } 9 }
10 values { 10 values {
11 iterator *ret; /*@ the iterator with all views, must be freed after use */ 11 iterator *ret; /*@ The iterator with all views, must be freed after use */
12 } 12 }
13 } 13 }
14 package { 14 package {
@@ -35,7 +35,7 @@ class Elm_App_Client (Eo.Base)
35 /*@ Terminate application. */ 35 /*@ Terminate application. */
36 } 36 }
37 view_open { 37 view_open {
38 /*@ Open a application view. */ 38 /*@ Open an application view. */
39 params { 39 params {
40 @in Eina_Value *args; /*@ an array of */ 40 @in Eina_Value *args; /*@ an array of */
41 @in Elm_App_Client_Open_View_Cb view_open_cb; /*@ callback to be called when view open */ 41 @in Elm_App_Client_Open_View_Cb view_open_cb; /*@ callback to be called when view open */
diff --git a/src/lib/elm_config.h b/src/lib/elm_config.h
index aa8a7cb4b..58d23df56 100644
--- a/src/lib/elm_config.h
+++ b/src/lib/elm_config.h
@@ -430,7 +430,7 @@ EAPI double elm_config_scroll_thumbscroll_friction_standard_get(void);
430 * same with thumbscroll friction, if the velocity is same with standard 430 * same with thumbscroll friction, if the velocity is same with standard
431 * velocity. 431 * velocity.
432 * 432 *
433 * @param friction the thumb scroll friction standard 433 * @param standard the thumb scroll friction standard
434 * 434 *
435 * @see elm_config_thumbscroll_friction_standard_get() 435 * @see elm_config_thumbscroll_friction_standard_get()
436 * @ingroup Scrolling 436 * @ingroup Scrolling
@@ -524,7 +524,7 @@ EAPI double elm_config_scroll_thumbscroll_acceleration_time_limit_get(void
524/** 524/**
525 * Set the time limit for accelerating velocity. 525 * Set the time limit for accelerating velocity.
526 * 526 *
527 * @param threshold the thumb scroll acceleration time limit 527 * @param time_limit the thumb scroll acceleration time limit
528 * 528 *
529 * @see elm_config_thumbscroll_acceleration_time_limit_get() 529 * @see elm_config_thumbscroll_acceleration_time_limit_get()
530 * @ingroup Scrolling 530 * @ingroup Scrolling
@@ -543,7 +543,7 @@ EAPI double elm_config_scroll_thumbscroll_acceleration_weight_get(void);
543/** 543/**
544 * Set the weight for the acceleration. 544 * Set the weight for the acceleration.
545 * 545 *
546 * @param threshold the thumb scroll acceleration weight 546 * @param weight the thumb scroll acceleration weight
547 * 547 *
548 * @see elm_config_thumbscroll_acceleration_weight_get() 548 * @see elm_config_thumbscroll_acceleration_weight_get()
549 * @ingroup Scrolling 549 * @ingroup Scrolling
@@ -960,7 +960,7 @@ EAPI Eina_Bool elm_config_access_get(void);
960/** 960/**
961 * Set access mode 961 * Set access mode
962 * 962 *
963 * @param is_accesss If @c EINA_TRUE, enables access mode 963 * @param is_access If @c EINA_TRUE, enables access mode
964 * 964 *
965 * @note Elementary objects may have information (e.g. label on the elm_button) 965 * @note Elementary objects may have information (e.g. label on the elm_button)
966 * to be read. This information is read by access module when an object 966 * 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);
1377/** 1377/**
1378 * Set the disable status of the item select on focus feature. 1378 * Set the disable status of the item select on focus feature.
1379 * 1379 *
1380 * @param disable Disable item select on focus if @c EINA_TRUE, enable otherwise 1380 * @param disabled Disable item select on focus if @c EINA_TRUE, enable otherwise
1381 * 1381 *
1382 * @see elm_config_item_select_on_focus_disabled_get 1382 * @see elm_config_item_select_on_focus_disabled_get
1383 * @since 1.10 1383 * @since 1.10
1384 * @ingroup Focus 1384 * @ingroup Focus
1385 */ 1385 */
1386EAPI void elm_config_item_select_on_focus_disabled_set(Eina_Bool enabled); 1386EAPI void elm_config_item_select_on_focus_disabled_set(Eina_Bool disabled);
1387 1387
1388/** 1388/**
1389 * Get status of first item focus on first focusin feature. 1389 * 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);
1399/** 1399/**
1400 * Set the first item focus on first focusin feature. 1400 * Set the first item focus on first focusin feature.
1401 * 1401 *
1402 * @param enable first_item_focus_on_first_focusin if @c EINA_TRUE, enable otherwise 1402 * @param enabled first_item_focus_on_first_focusin if @c EINA_TRUE, enable otherwise
1403 * 1403 *
1404 * @see elm_config_first_item_focus_on_first_focusin_get 1404 * @see elm_config_first_item_focus_on_first_focusin_get
1405 * @since 1.11 1405 * @since 1.11
@@ -1483,7 +1483,7 @@ EAPI double elm_config_glayer_double_tap_timeout_get(void);
1483/** 1483/**
1484 * Set the duration for occurring double tap event of gesture layer. 1484 * Set the duration for occurring double tap event of gesture layer.
1485 * 1485 *
1486 * @param long_tap_timeout Timeout for double tap event of gesture layer. 1486 * @param double_tap_timeout Timeout for double tap event of gesture layer.
1487 * @ingroup Elm_Gesture_Layer 1487 * @ingroup Elm_Gesture_Layer
1488 * @since 1.8 1488 * @since 1.8
1489 */ 1489 */
diff --git a/src/lib/elm_gesture_layer_common.h b/src/lib/elm_gesture_layer_common.h
index 398ce1862..60f52605c 100644
--- a/src/lib/elm_gesture_layer_common.h
+++ b/src/lib/elm_gesture_layer_common.h
@@ -434,7 +434,7 @@ EAPI double elm_gesture_layer_double_tap_timeout_get(const Evas_Object *obj);
434 * Set to ZERO if you want GLayer to use system finger size value (default) 434 * Set to ZERO if you want GLayer to use system finger size value (default)
435 * 435 *
436 * @param obj gesture-layer. 436 * @param obj gesture-layer.
437 * @param fsize Finger size 437 * @param sz Finger size
438 * 438 *
439 * @since 1.8 439 * @since 1.8
440 * @ingroup Elm_Gesture_Layer 440 * @ingroup Elm_Gesture_Layer
diff --git a/src/lib/elm_map_common.h b/src/lib/elm_map_common.h
index 74cec96da..9d30a7155 100644
--- a/src/lib/elm_map_common.h
+++ b/src/lib/elm_map_common.h
@@ -509,10 +509,10 @@ EAPI void elm_map_overlays_show(Eina_List *overlays);
509EAPI void elm_map_overlay_get_cb_set(Elm_Map_Overlay *overlay, Elm_Map_Overlay_Get_Cb get_cb, void *data); 509EAPI void elm_map_overlay_get_cb_set(Elm_Map_Overlay *overlay, Elm_Map_Overlay_Get_Cb get_cb, void *data);
510 510
511/** 511/**
512 * Set the get callback function to call when the overlay is deleted. 512 * Set the del callback function to call when the overlay is deleted.
513 * 513 *
514 * @param overlay The overlay to own the del callback function. 514 * @param overlay The overlay to own the del callback function.
515 * @param get_cb The callback function. 515 * @param del_cb The callback function.
516 * @param data The user callback data. 516 * @param data The user callback data.
517 * 517 *
518 * If the overlay is deleted, the callback wll be called. 518 * If the overlay is deleted, the callback wll be called.
diff --git a/src/lib/elm_prefs_data.h b/src/lib/elm_prefs_data.h
index 603cbcb00..e2890c6f7 100644
--- a/src/lib/elm_prefs_data.h
+++ b/src/lib/elm_prefs_data.h
@@ -181,7 +181,7 @@ EAPI void elm_prefs_data_unref(Elm_Prefs_Data *prefs_data);
181 * Set (or delete) one value of a given prefs data handle. 181 * Set (or delete) one value of a given prefs data handle.
182 * 182 *
183 * @param prefs_data A valid prefs data handle 183 * @param prefs_data A valid prefs data handle
184 * @param name The (unique) name (key) of the given value 184 * @param path The (unique) name (key) of the given value
185 * @param type The item type to which the value is to be associated 185 * @param type The item type to which the value is to be associated
186 * @param value The value, itself. It must be a valid @c Eina_Value 186 * @param value The value, itself. It must be a valid @c Eina_Value
187 * handle, bound to a given type and value or @c NULL. On 187 * 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,
204 * Retrieve one value of a given prefs data handle (by key). 204 * Retrieve one value of a given prefs data handle (by key).
205 * 205 *
206 * @param prefs_data A valid prefs data handle 206 * @param prefs_data A valid prefs data handle
207 * @param name The (unique) name (key) of the given value 207 * @param path The (unique) name (key) of the given value
208 * @param type The item type associated with the value 208 * @param type The item type associated with the value
209 * @param value A valid @c Eina_Value handle, where to store the 209 * @param value A valid @c Eina_Value handle, where to store the
210 * value, itself. 210 * value, itself.
@@ -258,7 +258,7 @@ EAPI Eina_Bool elm_prefs_data_event_callback_add(Elm_Prefs_Data *prefs_dat
258 * @since 1.8 258 * @since 1.8
259 */ 259 */
260EAPI Eina_Bool elm_prefs_data_event_callback_del(Elm_Prefs_Data *prefs_data, 260EAPI Eina_Bool elm_prefs_data_event_callback_del(Elm_Prefs_Data *prefs_data,
261 Elm_Prefs_Data_Event_Type t, 261 Elm_Prefs_Data_Event_Type type,
262 Elm_Prefs_Data_Event_Cb cb, 262 Elm_Prefs_Data_Event_Cb cb,
263 const void *cb_data); 263 const void *cb_data);
264 264
diff --git a/src/lib/elm_toolbar_common.h b/src/lib/elm_toolbar_common.h
index 032f6f469..09d1eabd5 100644
--- a/src/lib/elm_toolbar_common.h
+++ b/src/lib/elm_toolbar_common.h
@@ -420,23 +420,25 @@ EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Object_Item *i
420 * Show a specific item, when the toolbar can be scrolled. 420 * Show a specific item, when the toolbar can be scrolled.
421 * 421 *
422 * @param it the toolbar item 422 * @param it the toolbar item
423 * @param scrollto the position the item should appear at
423 * 424 *
424 * see elm_toolbar_item_bring_in() 425 * see elm_toolbar_item_bring_in()
425 * 426 *
426 * @since 1.8 427 * @since 1.8
427 * @ingroup Toolbar 428 * @ingroup Toolbar
428 */ 429 */
429EAPI void elm_toolbar_item_show(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type type); 430EAPI void elm_toolbar_item_show(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type scrollto);
430 431
431/** 432/**
432 * Show a specific item with scroll animation, when the toolbar can be scrolled. 433 * Show a specific item with scroll animation, when the toolbar can be scrolled.
433 * 434 *
434 * @param it the toolbar item 435 * @param it the toolbar item
436 * @param scrollto the position the item should appear at
435 * 437 *
436 * see elm_toolbar_item_show() 438 * see elm_toolbar_item_show()
437 * 439 *
438 * @since 1.8 440 * @since 1.8
439 * @ingroup Toolbar 441 * @ingroup Toolbar
440 */ 442 */
441EAPI void elm_toolbar_item_bring_in(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type type); 443EAPI void elm_toolbar_item_bring_in(Elm_Object_Item *it, Elm_Toolbar_Item_Scrollto_Type scrollto);
442 444
diff --git a/src/lib/elm_transit.h b/src/lib/elm_transit.h
index b490bff7a..32ffe5982 100644
--- a/src/lib/elm_transit.h
+++ b/src/lib/elm_transit.h
@@ -633,7 +633,7 @@ EAPI Eina_List *elm_transit_chain_transits_get(const Elm_Transit *tr
633/** 633/**
634 * Set the smooth effect for a transit. 634 * Set the smooth effect for a transit.
635 * 635 *
636 * @param obj The transit object 636 * @param transit The transit object
637 * @param enabled enable or disable smooth map rendering 637 * @param enabled enable or disable smooth map rendering
638 * 638 *
639 * This sets smoothing for transit map rendering. If the object added in a 639 * 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
646 * 646 *
647 * @ingroup Transit 647 * @ingroup Transit
648 */ 648 */
649EAPI void elm_transit_smooth_set(Elm_Transit *transit, Eina_Bool smooth); 649EAPI void elm_transit_smooth_set(Elm_Transit *transit, Eina_Bool enabled);
650 650
651/** 651/**
652 * Get the smooth scaling for transit map rendering 652 * Get the smooth scaling for transit map rendering
653 * 653 *
654 * This gets smooth scaling for transit map rendering. 654 * This gets smooth scaling for transit map rendering.
655 * 655 *
656 * @param obj The transit object 656 * @param transit The transit object
657 * @return @c EINA_TRUE if the smooth is enabled, @c EINA_FALSE otherwise. 657 * @return @c EINA_TRUE if the smooth is enabled, @c EINA_FALSE otherwise.
658 * 658 *
659 * @see elm_transit_smooth_set() 659 * @see elm_transit_smooth_set()
diff --git a/src/lib/elm_win.eo b/src/lib/elm_win.eo
index dc51063e2..ff71cd16c 100644
--- a/src/lib/elm_win.eo
+++ b/src/lib/elm_win.eo
@@ -134,7 +134,7 @@ class Elm_Win (Elm_Widget, Elm_Interface_Atspi_Window,
134 } 134 }
135 values { 135 values {
136 int *rotations @const_set; /*@ The array of rotation value. */ 136 int *rotations @const_set; /*@ The array of rotation value. */
137 uint count; /*@ The number of array of rotations */ 137 uint count; /*@ The size of the @param rotations array. */
138 } 138 }
139 } 139 }
140 quickpanel_zone { 140 quickpanel_zone {