clean up lots of doxygen complaints - bad docs.

SVN revision: 66669

legacy/elementary/src/lib/elc_fileselector_entry.h

@@ -212,8 +212,7 @@ EAPI const char                 *elm_fileselector_entry_path_get(const Evas_Obje
  * widget's internal file selector
  *
  * @param obj The file selector entry widget
- * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
- * disable
+ * @param value @c EINA_TRUE to enable tree view, @c EINA_FALSE to disable
  *
  * This has the same effect as elm_fileselector_expandable_set(),
  * 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
  * as well.
  *
  * @param obj The file selector entry widget
- * @param only @c EINA_TRUE to make @p obj widget's internal file
+ * @param value @c EINA_TRUE to make @p obj widget's internal file
  * selector only display directories, @c EINA_FALSE to make files
  * to be displayed in it too
  *
@@ -277,7 +276,7 @@ EAPI Eina_Bool                   elm_fileselector_entry_folder_only_get(const Ev
  * internal file selector.
  *
  * @param obj The file selector entry widget
- * @param is_save @c EINA_TRUE to make @p obj widget's internal
+ * @param value @c EINA_TRUE to make @p obj widget's internal
  * file selector a "saving dialog", @c EINA_FALSE otherwise
  *
  * This has the same effect as elm_fileselector_is_save_set(),

legacy/elementary/src/lib/elc_hoversel.h

@@ -251,7 +251,7 @@ EAPI void                         elm_hoversel_item_del(Elm_Object_Item *it) EIN
  * @brief Set the function to be called when an item from the hoversel is
  * freed.
  *
- * @param item The item to set the callback on
+ * @param it The item to set the callback on
  * @param func The function called
  *
  * That function will receive these parameters:
@@ -289,7 +289,7 @@ EINA_DEPRECATED EAPI const char  *elm_hoversel_item_label_get(const Elm_Object_I
 /**
  * @brief This sets the icon for the given hoversel item.
  *
- * @param item The item to set the icon
+ * @param it The item to set the icon
  * @param icon_file An image file path on disk to use for the icon or standard
  * icon name
  * @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
 /**
  * @brief Get the icon object of the hoversel item
  *
- * @param item The item to get the icon from
+ * @param it The item to get the icon from
  * @param icon_file The image file path on disk used for the icon or standard
  * icon name
  * @param icon_group The edje group used if @p icon_file is an edje file. NULL

legacy/elementary/src/lib/elc_multibuttonentry.h

@@ -18,9 +18,6 @@
  * - @c "expanded" - when multibuttonentry is expanded.
  * - @c "shrank" - when multibuttonentry is shrank.
  * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed.
- *
- * Here is an example on its usage:
- * @li @ref multibuttonentry_example
  */
 
 /**
@@ -82,7 +79,7 @@ EAPI const char                *elm_multibuttonentry_guide_text_get(const Evas_O
  * Set the guide text
  *
  * @param obj The multibuttonentry object
- * @param label The guide text string
+ * @param guidetext The guide text string
  *
  */
 EAPI 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
  * Get the value of shrink_mode state.
  *
  * @param obj The multibuttonentry object
- * @param the value of shrink mode state.
+ * @return the value of shrink mode state.
  *
  */
 EAPI 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_
  * Set/Unset the multibuttonentry to shrink mode state of single line
  *
  * @param obj The multibuttonentry object
- * @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.
+ * @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.
  *
  */
 EAPI 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
  * Set the label of a given item
  *
  * @param item The item
- * @param label The text label string
+ * @param str The text label string
  *
  */
 EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str) EINA_ARG_NONNULL(1);

legacy/elementary/src/lib/elc_naviframe.h

@@ -45,8 +45,6 @@
  * @li elm_object_item_content_unset
  * @li elm_object_item_part_content_unset
  * @li elm_object_item_signal_emit
- *
- * @ref tutorial_naviframe gives a good overview of the usage of the API.
  */
 
 /**
@@ -259,7 +257,7 @@ EAPI Elm_Object_Item *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA
 /**
  * @brief Set an item style
  *
- * @param obj The naviframe item
+ * @param it The naviframe item
  * @param item_style The current item style name. @c NULL would be default
  *
  * 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
 /**
  * @brief Get an item style
  *
- * @param obj The naviframe item
+ * @param it The naviframe item
  * @return The current item style name
  *
  * @see also elm_naviframe_item_style_set()

legacy/elementary/src/lib/elm_box.h

@@ -240,6 +240,7 @@ EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
  * deleting it.
  *
  * @param obj The box object
+ * @param subobj The object to unpack
  *
  * @see elm_box_unpack_all()
  * @see elm_box_clear()
@@ -421,10 +422,12 @@ EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object
  * set the definitive layout for the box, usually the same as the end
  * layout for the animation, but could be used to start another transition.
  *
+ * @param duration The duration of the transition in seconds
  * @param start_layout The layout function that will be used to start the animation
  * @param start_layout_data The data to be passed the @p start_layout function
  * @param start_layout_free_data Function to free @p start_layout_data
  * @param end_layout The layout function that will be used to end the animation
+ * @param end_layout_data Data param passed to @p end_layout
  * @param end_layout_free_data The data to be passed the @p end_layout function
  * @param end_layout_free_data Function to free @p end_layout_data
  * @param transition_end_cb Callback function called when animation ends

legacy/elementary/src/lib/elm_cache.h

@@ -87,7 +87,7 @@ EAPI Eina_Bool elm_cache_flush_enabled_get(void);
  *
  * This sets the globally configured cache flush enabled state.
  *
- * @param size The cache flush enabled state
+ * @param enabled The cache flush enabled state
  * @ingroup Caches
  *
  * @see elm_all_flush()
@@ -101,7 +101,7 @@ EAPI void      elm_cache_flush_enabled_set(Eina_Bool enabled);
  * This sets the globally configured cache flush enabled state for all
  * applications on the display.
  *
- * @param size The cache flush enabled state
+ * @param enabled The cache flush enabled state
  * @ingroup Caches
  */
 // XXX: deprecate and replace with elm_config_all_flush()

legacy/elementary/src/lib/elm_check.h

@@ -29,19 +29,18 @@
  * Default text parts of the check widget that you can use for are:
  * @li "elm.text" - Label of the check
  *
- * @ref tutorial_check should give you a firm grasp of how to use this widget
- * .
+ * @ref tutorial_check should give you a firm grasp of how to use this widget.
+ * 
  * @{
  */
+
 /**
  * @brief Add a new Check object
  *
  * @param parent The parent object
  * @return The new object or NULL if it cannot be created
  */
-EAPI Evas_Object *
-                                  elm_check_add(Evas_Object *parent)
-EINA_ARG_NONNULL(1);
+EAPI Evas_Object *                elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
 
 /**
  * @brief Set the text label of the check object

legacy/elementary/src/lib/elm_clock.h

@@ -144,12 +144,11 @@ EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int
 EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
 
 /**
- * Retrieve whether a given clock widget is under <b>edition
- * mode</b> or under (default) displaying-only mode.
+ * Retrieve whether a given clock widget is under editing mode
+ * or under (default) displaying-only mode.
  *
  * @param obj The clock object
- * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
- * otherwise
+ * @return @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE otherwise
  *
  * This function retrieves whether the clock's time can be edited
  * or not by user interaction.

legacy/elementary/src/lib/elm_debug.h

@@ -16,7 +16,7 @@ EAPI void elm_object_tree_dump(const Evas_Object *top);
 /**
  * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
  *
- * @param obj The root object
+ * @param top The root object
  * @param file The path of output file
  * @ingroup Debug
  */

legacy/elementary/src/lib/elm_diskselector.h

@@ -319,7 +319,7 @@ EAPI Elm_Diskselector_Item *elm_diskselector_item_append(Evas_Object *obj, const
 /**
  * Delete them item from the diskselector.
  *
- * @param it The item of diskselector to be deleted.
+ * @param item The item of diskselector to be deleted.
  *
  * If deleting all diskselector items is required, elm_diskselector_clear()
  * 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
 /**
  * Set the function called when a diskselector item is freed.
  *
- * @param it The item to set the callback on
+ * @param item The item to set the callback on
  * @param func The function called
  *
  * 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
 /**
  * Get the data associated to the item.
  *
- * @param it The diskselector item
+ * @param item The diskselector item
  * @return The data associated to @p it
  *
  * 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
 /**
  * Set the icon associated to the item.
  *
- * @param it The diskselector item
+ * @param item The diskselector item
  * @param icon The icon object to associate with @p it
  *
  * 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
 /**
  * Set the label of item.
  *
- * @param it The item of diskselector.
+ * @param item The item of diskselector.
  * @param label The label of item.
  *
  * The label to be displayed by the item.
@@ -448,7 +448,7 @@ EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Ite
 /**
  * Get the label of item.
  *
- * @param it The item of diskselector.
+ * @param item The item of diskselector.
  * @return The label of item.
  *
  * 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
 /**
  * Set the selected state of an item.
  *
- * @param it The diskselector item
+ * @param item The diskselector item
  * @param selected The selected state
  *
  * This sets the selected state of the given item @p it.
@@ -513,7 +513,7 @@ EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_
 /*
  * Get whether the @p item is selected or not.
  *
- * @param it The diskselector item.
+ * @param item The diskselector item.
  * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
  * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
  *
@@ -559,7 +559,7 @@ EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *ob
 /**
  * Get the item before @p item in diskselector.
  *
- * @param it The diskselector item.
+ * @param item The diskselector item.
  * @return The item before @p item, or @c NULL if none or on failure.
  *
  * 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
 /**
  * Get the item after @p item in diskselector.
  *
- * @param it The diskselector item.
+ * @param item The diskselector item.
  * @return The item after @p item, or @c NULL if none or on failure.
  *
  * The list of items follows append order. So it will return item appended