summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorCarsten Haitzler <raster@rasterman.com>2011-12-30 07:41:47 +0000
committerCarsten Haitzler <raster@rasterman.com>2011-12-30 07:41:47 +0000
commitecbed3b80ef598178c52ee481f06fe6b7883716b (patch)
tree5ec59cf54b72bc18e44de96ccaccb0b8a34f0b58 /src
parent9b88df52ad31fc6974a6fcf062e5e59ceabd3bc3 (diff)
clean up lots of doxygen complaints - bad docs.
SVN revision: 66669
Diffstat (limited to 'src')
-rw-r--r--src/lib/elc_fileselector_entry.h7
-rw-r--r--src/lib/elc_hoversel.h6
-rw-r--r--src/lib/elc_multibuttonentry.h11
-rw-r--r--src/lib/elc_naviframe.h6
-rw-r--r--src/lib/elm_box.h3
-rw-r--r--src/lib/elm_cache.h4
-rw-r--r--src/lib/elm_check.h9
-rw-r--r--src/lib/elm_clock.h7
-rw-r--r--src/lib/elm_debug.h2
-rw-r--r--src/lib/elm_diskselector.h20
10 files changed, 35 insertions, 40 deletions
diff --git a/src/lib/elc_fileselector_entry.h b/src/lib/elc_fileselector_entry.h
index d584b7fc3..b60b19041 100644
--- a/src/lib/elc_fileselector_entry.h
+++ b/src/lib/elc_fileselector_entry.h
@@ -212,8 +212,7 @@ EAPI const char *elm_fileselector_entry_path_get(const Evas_Obje
212 * widget's internal file selector 212 * widget's internal file selector
213 * 213 *
214 * @param obj The file selector entry widget 214 * @param obj The file selector entry widget
215 * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to 215 * @param value @c EINA_TRUE to enable tree view, @c EINA_FALSE to disable
216 * disable
217 * 216 *
218 * This has the same effect as elm_fileselector_expandable_set(), 217 * This has the same effect as elm_fileselector_expandable_set(),
219 * but now applied to a file selector entry's internal file 218 * but now applied to a file selector entry's internal file
@@ -245,7 +244,7 @@ EAPI Eina_Bool elm_fileselector_entry_expandable_get(const Eva
245 * as well. 244 * as well.
246 * 245 *
247 * @param obj The file selector entry widget 246 * @param obj The file selector entry widget
248 * @param only @c EINA_TRUE to make @p obj widget's internal file 247 * @param value @c EINA_TRUE to make @p obj widget's internal file
249 * selector only display directories, @c EINA_FALSE to make files 248 * selector only display directories, @c EINA_FALSE to make files
250 * to be displayed in it too 249 * to be displayed in it too
251 * 250 *
@@ -277,7 +276,7 @@ EAPI Eina_Bool elm_fileselector_entry_folder_only_get(const Ev
277 * internal file selector. 276 * internal file selector.
278 * 277 *
279 * @param obj The file selector entry widget 278 * @param obj The file selector entry widget
280 * @param is_save @c EINA_TRUE to make @p obj widget's internal 279 * @param value @c EINA_TRUE to make @p obj widget's internal
281 * file selector a "saving dialog", @c EINA_FALSE otherwise 280 * file selector a "saving dialog", @c EINA_FALSE otherwise
282 * 281 *
283 * This has the same effect as elm_fileselector_is_save_set(), 282 * This has the same effect as elm_fileselector_is_save_set(),
diff --git a/src/lib/elc_hoversel.h b/src/lib/elc_hoversel.h
index f68bbd851..eb99109e5 100644
--- a/src/lib/elc_hoversel.h
+++ b/src/lib/elc_hoversel.h
@@ -251,7 +251,7 @@ EAPI void elm_hoversel_item_del(Elm_Object_Item *it) EIN
251 * @brief Set the function to be called when an item from the hoversel is 251 * @brief Set the function to be called when an item from the hoversel is
252 * freed. 252 * freed.
253 * 253 *
254 * @param item The item to set the callback on 254 * @param it The item to set the callback on
255 * @param func The function called 255 * @param func The function called
256 * 256 *
257 * That function will receive these parameters: 257 * That function will receive these parameters:
@@ -289,7 +289,7 @@ EINA_DEPRECATED EAPI const char *elm_hoversel_item_label_get(const Elm_Object_I
289/** 289/**
290 * @brief This sets the icon for the given hoversel item. 290 * @brief This sets the icon for the given hoversel item.
291 * 291 *
292 * @param item The item to set the icon 292 * @param it The item to set the icon
293 * @param icon_file An image file path on disk to use for the icon or standard 293 * @param icon_file An image file path on disk to use for the icon or standard
294 * icon name 294 * icon name
295 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this 295 * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
@@ -306,7 +306,7 @@ EAPI void elm_hoversel_item_icon_set(Elm_Object_Item *it
306/** 306/**
307 * @brief Get the icon object of the hoversel item 307 * @brief Get the icon object of the hoversel item
308 * 308 *
309 * @param item The item to get the icon from 309 * @param it The item to get the icon from
310 * @param icon_file The image file path on disk used for the icon or standard 310 * @param icon_file The image file path on disk used for the icon or standard
311 * icon name 311 * icon name
312 * @param icon_group The edje group used if @p icon_file is an edje file. NULL 312 * @param icon_group The edje group used if @p icon_file is an edje file. NULL
diff --git a/src/lib/elc_multibuttonentry.h b/src/lib/elc_multibuttonentry.h
index 7eab7b5df..3c4ae0905 100644
--- a/src/lib/elc_multibuttonentry.h
+++ b/src/lib/elc_multibuttonentry.h
@@ -18,9 +18,6 @@
18 * - @c "expanded" - when multibuttonentry is expanded. 18 * - @c "expanded" - when multibuttonentry is expanded.
19 * - @c "shrank" - when multibuttonentry is shrank. 19 * - @c "shrank" - when multibuttonentry is shrank.
20 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed. 20 * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
21 *
22 * Here is an example on its usage:
23 * @li @ref multibuttonentry_example
24 */ 21 */
25 22
26/** 23/**
@@ -82,7 +79,7 @@ EAPI const char *elm_multibuttonentry_guide_text_get(const Evas_O
82 * Set the guide text 79 * Set the guide text
83 * 80 *
84 * @param obj The multibuttonentry object 81 * @param obj The multibuttonentry object
85 * @param label The guide text string 82 * @param guidetext The guide text string
86 * 83 *
87 */ 84 */
88EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1); 85EAPI void elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext) EINA_ARG_NONNULL(1);
@@ -91,7 +88,7 @@ EAPI void elm_multibuttonentry_guide_text_set(Evas_Object
91 * Get the value of shrink_mode state. 88 * Get the value of shrink_mode state.
92 * 89 *
93 * @param obj The multibuttonentry object 90 * @param obj The multibuttonentry object
94 * @param the value of shrink mode state. 91 * @return the value of shrink mode state.
95 * 92 *
96 */ 93 */
97EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); 94EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
@@ -100,7 +97,7 @@ EAPI int elm_multibuttonentry_shrink_mode_get(const Evas_
100 * Set/Unset the multibuttonentry to shrink mode state of single line 97 * Set/Unset the multibuttonentry to shrink mode state of single line
101 * 98 *
102 * @param obj The multibuttonentry object 99 * @param obj The multibuttonentry object
103 * @param the value of shrink_mode state. set this to 1 to set the multibuttonentry to shrink state of single line. set this to 0 to unset the contracted state. 100 * @param shrink the value of shrink_mode state. set this to 1 to set the multibuttonentry to shrink state of single line. set this to 0 to unset the contracted state.
104 * 101 *
105 */ 102 */
106EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1); 103EAPI void elm_multibuttonentry_shrink_mode_set(Evas_Object *obj, int shrink) EINA_ARG_NONNULL(1);
@@ -234,7 +231,7 @@ EAPI const char *elm_multibuttonentry_item_label_get(const Elm_Mu
234 * Set the label of a given item 231 * Set the label of a given item
235 * 232 *
236 * @param item The item 233 * @param item The item
237 * @param label The text label string 234 * @param str The text label string
238 * 235 *
239 */ 236 */
240EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1); 237EAPI void elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);
diff --git a/src/lib/elc_naviframe.h b/src/lib/elc_naviframe.h
index e81a742a2..1b9133c01 100644
--- a/src/lib/elc_naviframe.h
+++ b/src/lib/elc_naviframe.h
@@ -45,8 +45,6 @@
45 * @li elm_object_item_content_unset 45 * @li elm_object_item_content_unset
46 * @li elm_object_item_part_content_unset 46 * @li elm_object_item_part_content_unset
47 * @li elm_object_item_signal_emit 47 * @li elm_object_item_signal_emit
48 *
49 * @ref tutorial_naviframe gives a good overview of the usage of the API.
50 */ 48 */
51 49
52/** 50/**
@@ -259,7 +257,7 @@ EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA
259/** 257/**
260 * @brief Set an item style 258 * @brief Set an item style
261 * 259 *
262 * @param obj The naviframe item 260 * @param it The naviframe item
263 * @param item_style The current item style name. @c NULL would be default 261 * @param item_style The current item style name. @c NULL would be default
264 * 262 *
265 * The following styles are available for this item: 263 * The following styles are available for this item:
@@ -274,7 +272,7 @@ EAPI void elm_naviframe_item_style_set(Elm_Object_Item *it, const ch
274/** 272/**
275 * @brief Get an item style 273 * @brief Get an item style
276 * 274 *
277 * @param obj The naviframe item 275 * @param it The naviframe item
278 * @return The current item style name 276 * @return The current item style name
279 * 277 *
280 * @see also elm_naviframe_item_style_set() 278 * @see also elm_naviframe_item_style_set()
diff --git a/src/lib/elm_box.h b/src/lib/elm_box.h
index 2e0517a88..bc45693ab 100644
--- a/src/lib/elm_box.h
+++ b/src/lib/elm_box.h
@@ -240,6 +240,7 @@ EAPI void elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
240 * deleting it. 240 * deleting it.
241 * 241 *
242 * @param obj The box object 242 * @param obj The box object
243 * @param subobj The object to unpack
243 * 244 *
244 * @see elm_box_unpack_all() 245 * @see elm_box_unpack_all()
245 * @see elm_box_clear() 246 * @see elm_box_clear()
@@ -421,10 +422,12 @@ EAPI void elm_box_layout_transition(Evas_Object *obj, Evas_Object
421 * set the definitive layout for the box, usually the same as the end 422 * set the definitive layout for the box, usually the same as the end
422 * layout for the animation, but could be used to start another transition. 423 * layout for the animation, but could be used to start another transition.
423 * 424 *
425 * @param duration The duration of the transition in seconds
424 * @param start_layout The layout function that will be used to start the animation 426 * @param start_layout The layout function that will be used to start the animation
425 * @param start_layout_data The data to be passed the @p start_layout function 427 * @param start_layout_data The data to be passed the @p start_layout function
426 * @param start_layout_free_data Function to free @p start_layout_data 428 * @param start_layout_free_data Function to free @p start_layout_data
427 * @param end_layout The layout function that will be used to end the animation 429 * @param end_layout The layout function that will be used to end the animation
430 * @param end_layout_data Data param passed to @p end_layout
428 * @param end_layout_free_data The data to be passed the @p end_layout function 431 * @param end_layout_free_data The data to be passed the @p end_layout function
429 * @param end_layout_free_data Function to free @p end_layout_data 432 * @param end_layout_free_data Function to free @p end_layout_data
430 * @param transition_end_cb Callback function called when animation ends 433 * @param transition_end_cb Callback function called when animation ends
diff --git a/src/lib/elm_cache.h b/src/lib/elm_cache.h
index f6e6e4e0c..8ef12735c 100644
--- a/src/lib/elm_cache.h
+++ b/src/lib/elm_cache.h
@@ -87,7 +87,7 @@ EAPI Eina_Bool elm_cache_flush_enabled_get(void);
87 * 87 *
88 * This sets the globally configured cache flush enabled state. 88 * This sets the globally configured cache flush enabled state.
89 * 89 *
90 * @param size The cache flush enabled state 90 * @param enabled The cache flush enabled state
91 * @ingroup Caches 91 * @ingroup Caches
92 * 92 *
93 * @see elm_all_flush() 93 * @see elm_all_flush()
@@ -101,7 +101,7 @@ EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
101 * This sets the globally configured cache flush enabled state for all 101 * This sets the globally configured cache flush enabled state for all
102 * applications on the display. 102 * applications on the display.
103 * 103 *
104 * @param size The cache flush enabled state 104 * @param enabled The cache flush enabled state
105 * @ingroup Caches 105 * @ingroup Caches
106 */ 106 */
107// XXX: deprecate and replace with elm_config_all_flush() 107// XXX: deprecate and replace with elm_config_all_flush()
diff --git a/src/lib/elm_check.h b/src/lib/elm_check.h
index 9f51a5655..622a292f3 100644
--- a/src/lib/elm_check.h
+++ b/src/lib/elm_check.h
@@ -29,19 +29,18 @@
29 * Default text parts of the check widget that you can use for are: 29 * Default text parts of the check widget that you can use for are:
30 * @li "elm.text" - Label of the check 30 * @li "elm.text" - Label of the check
31 * 31 *
32 * @ref tutorial_check should give you a firm grasp of how to use this widget 32 * @ref tutorial_check should give you a firm grasp of how to use this widget.
33 * . 33 *
34 * @{ 34 * @{
35 */ 35 */
36
36/** 37/**
37 * @brief Add a new Check object 38 * @brief Add a new Check object
38 * 39 *
39 * @param parent The parent object 40 * @param parent The parent object
40 * @return The new object or NULL if it cannot be created 41 * @return The new object or NULL if it cannot be created
41 */ 42 */
42EAPI Evas_Object * 43EAPI Evas_Object * elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
43 elm_check_add(Evas_Object *parent)
44EINA_ARG_NONNULL(1);
45 44
46/** 45/**
47 * @brief Set the text label of the check object 46 * @brief Set the text label of the check object
diff --git a/src/lib/elm_clock.h b/src/lib/elm_clock.h
index 057b505ec..69f134800 100644
--- a/src/lib/elm_clock.h
+++ b/src/lib/elm_clock.h
@@ -144,12 +144,11 @@ EAPI void elm_clock_time_get(const Evas_Object *obj, int *hrs, int
144EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1); 144EAPI void elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
145 145
146/** 146/**
147 * Retrieve whether a given clock widget is under <b>edition 147 * Retrieve whether a given clock widget is under editing mode
148 * mode</b> or under (default) displaying-only mode. 148 * or under (default) displaying-only mode.
149 * 149 *
150 * @param obj The clock object 150 * @param obj The clock object
151 * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE 151 * @return @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE otherwise
152 * otherwise
153 * 152 *
154 * This function retrieves whether the clock's time can be edited 153 * This function retrieves whether the clock's time can be edited
155 * or not by user interaction. 154 * or not by user interaction.
diff --git a/src/lib/elm_debug.h b/src/lib/elm_debug.h
index 3d4efbf97..97dd18f7b 100644
--- a/src/lib/elm_debug.h
+++ b/src/lib/elm_debug.h
@@ -16,7 +16,7 @@ EAPI void elm_object_tree_dump(const Evas_Object *top);
16/** 16/**
17 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax. 17 * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
18 * 18 *
19 * @param obj The root object 19 * @param top The root object
20 * @param file The path of output file 20 * @param file The path of output file
21 * @ingroup Debug 21 * @ingroup Debug
22 */ 22 */
diff --git a/src/lib/elm_diskselector.h b/src/lib/elm_diskselector.h
index 8444490b4..9b95fbd6c 100644
--- a/src/lib/elm_diskselector.h
+++ b/src/lib/elm_diskselector.h
@@ -319,7 +319,7 @@ EAPI Elm_Diskselector_Item *elm_diskselector_item_append(Evas_Object *obj, const
319/** 319/**
320 * Delete them item from the diskselector. 320 * Delete them item from the diskselector.
321 * 321 *
322 * @param it The item of diskselector to be deleted. 322 * @param item The item of diskselector to be deleted.
323 * 323 *
324 * If deleting all diskselector items is required, elm_diskselector_clear() 324 * If deleting all diskselector items is required, elm_diskselector_clear()
325 * should be used instead of getting items list and deleting each one. 325 * should be used instead of getting items list and deleting each one.
@@ -335,7 +335,7 @@ EAPI void elm_diskselector_item_del(Elm_Diskselector_Item *ite
335/** 335/**
336 * Set the function called when a diskselector item is freed. 336 * Set the function called when a diskselector item is freed.
337 * 337 *
338 * @param it The item to set the callback on 338 * @param item The item to set the callback on
339 * @param func The function called 339 * @param func The function called
340 * 340 *
341 * If there is a @p func, then it will be called prior item's memory release. 341 * If there is a @p func, then it will be called prior item's memory release.
@@ -354,7 +354,7 @@ EAPI void elm_diskselector_item_del_cb_set(Elm_Diskselector_It
354/** 354/**
355 * Get the data associated to the item. 355 * Get the data associated to the item.
356 * 356 *
357 * @param it The diskselector item 357 * @param item The diskselector item
358 * @return The data associated to @p it 358 * @return The data associated to @p it
359 * 359 *
360 * The return value is a pointer to data associated to @p item when it was 360 * The return value is a pointer to data associated to @p item when it was
@@ -370,7 +370,7 @@ EAPI void *elm_diskselector_item_data_get(const Elm_Diskselecto
370/** 370/**
371 * Set the icon associated to the item. 371 * Set the icon associated to the item.
372 * 372 *
373 * @param it The diskselector item 373 * @param item The diskselector item
374 * @param icon The icon object to associate with @p it 374 * @param icon The icon object to associate with @p it
375 * 375 *
376 * The icon object to use at left side of the item. An 376 * The icon object to use at left side of the item. An
@@ -413,7 +413,7 @@ EAPI Evas_Object *elm_diskselector_item_icon_get(const Elm_Diskselecto
413/** 413/**
414 * Set the label of item. 414 * Set the label of item.
415 * 415 *
416 * @param it The item of diskselector. 416 * @param item The item of diskselector.
417 * @param label The label of item. 417 * @param label The label of item.
418 * 418 *
419 * The label to be displayed by the item. 419 * The label to be displayed by the item.
@@ -448,7 +448,7 @@ EAPI void elm_diskselector_item_label_set(Elm_Diskselector_Ite
448/** 448/**
449 * Get the label of item. 449 * Get the label of item.
450 * 450 *
451 * @param it The item of diskselector. 451 * @param item The item of diskselector.
452 * @return The label of item. 452 * @return The label of item.
453 * 453 *
454 * The return value is a pointer to the label associated to @p item when it was 454 * The return value is a pointer to the label associated to @p item when it was
@@ -485,7 +485,7 @@ EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object
485/** 485/**
486 * Set the selected state of an item. 486 * Set the selected state of an item.
487 * 487 *
488 * @param it The diskselector item 488 * @param item The diskselector item
489 * @param selected The selected state 489 * @param selected The selected state
490 * 490 *
491 * This sets the selected state of the given item @p it. 491 * This sets the selected state of the given item @p it.
@@ -513,7 +513,7 @@ EAPI void elm_diskselector_item_selected_set(Elm_Diskselector_
513/* 513/*
514 * Get whether the @p item is selected or not. 514 * Get whether the @p item is selected or not.
515 * 515 *
516 * @param it The diskselector item. 516 * @param item The diskselector item.
517 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates 517 * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
518 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned. 518 * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
519 * 519 *
@@ -559,7 +559,7 @@ EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *ob
559/** 559/**
560 * Get the item before @p item in diskselector. 560 * Get the item before @p item in diskselector.
561 * 561 *
562 * @param it The diskselector item. 562 * @param item The diskselector item.
563 * @return The item before @p item, or @c NULL if none or on failure. 563 * @return The item before @p item, or @c NULL if none or on failure.
564 * 564 *
565 * The list of items follows append order. So it will return item appended 565 * The list of items follows append order. So it will return item appended
@@ -578,7 +578,7 @@ EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselecto
578/** 578/**
579 * Get the item after @p item in diskselector. 579 * Get the item after @p item in diskselector.
580 * 580 *
581 * @param it The diskselector item. 581 * @param item The diskselector item.
582 * @return The item after @p item, or @c NULL if none or on failure. 582 * @return The item after @p item, or @c NULL if none or on failure.
583 * 583 *
584 * The list of items follows append order. So it will return item appended 584 * The list of items follows append order. So it will return item appended