Enhance documentation

- elm_entry.eo
- elm_flip.h
- elm_flipselector.h
- elm_config.h
- elm_focus.h
- elm_gen.h
- elm_object.h
- elm_genlist.eo
- elm_genlist.h
- elm_grid.eo
- elm_icon.h
- elm_image.h
- elm_image_legacy.h
- elm_index.h

Change-Id: Ic82c977595f8819f53552b38174815e06268952b

diff --git a/src/lib/elm_config.h b/src/lib/elm_config.h
index d6b2ced..3644cab 100644 (file)
--- a/src/lib/elm_config.h
+++ b/src/lib/elm_config.h
@@ -1016,6 +1016,10 @@ typedef enum
  * elementary will automatically scroll the focused area to the visible
  * viewport.
  *
+ * @return ELM_FOCUS_AUTOSCROLL_MODE_SHOW if directly show the focused region or item automatically.
+ *  ELM_FOCUS_AUTOSCROLL_MODE_NONE if do not show the focused region or item automatically.
+ *  ELM_FOCUS_AUTOSCROLL_MODE_BRING_IN if bring_in the focused region or item automatically which might invole the scrolling.
+ *
  * @see elm_config_focus_autoscroll_mode_set()
  * @ingroup Elm_Focus
  * @since 1.10
@@ -1525,6 +1529,7 @@ EAPI Eina_List *elm_config_text_classes_list_get(void);
 /**
  * Free Elementary's list of supported text classes.
  *
+ * @param list The text classes list.
  * @ingroup Elm_Fonts
  *
  * @see elm_config_text_classes_list_get().
@@ -1683,6 +1688,7 @@ EAPI void             elm_config_font_overlay_apply(void);
  * EVAS_FONT_HINTING_AUTO < Automatic font hinting
  * EVAS_FONT_HINTING_BYTECODE < Bytecode font hinting
  *
+ * @param type The font hinting type
  * @ingroup Elm_Fonts
  *
  * This applies font hint changes to all windows of the current application.

diff --git a/src/lib/elm_entry.eo b/src/lib/elm_entry.eo
index 62386d8..acab2ce 100644 (file)
--- a/src/lib/elm_entry.eo
+++ b/src/lib/elm_entry.eo
@@ -797,7 +797,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
               \@elseif WEARABLE \@since_tizen 2.3.1
               \@endif
             ]]
-            return: Evas.Object *;
+            return: Evas.Object *; [[Textblock object]]
          }
       }
       @property cursor_geometry {
@@ -812,7 +812,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
               \@elseif WEARABLE \@since_tizen 2.3.1
               \@endif
             ]]
-            return: bool;
+            return: bool; [[$true on success, $false otherwise]]
          }
          values {
             x: Evas.Coord; [[returned geometry.]]
@@ -851,7 +851,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
               \@elseif WEARABLE \@since_tizen 2.3.1
               \@endif
             ]]
-            return: bool;
+            return: bool; [[$true if format node exists, $false otherwise]]
          }
       }
       @property cursor_content {
@@ -861,13 +861,13 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
               This function returns a string with the utf8 character stored at the
               current cursor position.
               Only the text is returned, any format that may exist will not be part
-              of the return value. You must free the string when done with \@ref free.
+              of the return value. You must free the string when done with free.
 
               \@if MOBILE \@since_tizen 2.3
               \@elseif WEARABLE \@since_tizen 2.3.1
               \@endif
             ]]
-            return: own(char *) @warn_unused;
+            return: own(char *) @warn_unused; [[Character]]
          }
       }
       @property selection {
@@ -886,7 +886,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
               \@elseif WEARABLE \@since_tizen 2.3.1
               \@endif
             ]]
-            return: const(char)*;
+            return: const(char)*; [[Selected string]]
          }
       }
       @property cursor_is_visible_format {
@@ -897,7 +897,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
               \@elseif WEARABLE \@since_tizen 2.3.1
               \@endif
             ]]
-            return: bool;
+            return: bool; [[$true if position has a visible format, $false otherwise]]
          }
       }
       @property select_allow {
@@ -918,7 +918,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: bool;
+         return: bool; [[$true on success, $false otherwise]]
       }
       text_style_user_pop {
          [[Remove the style in the top of user style stack.
@@ -1005,7 +1005,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: bool;
+         return: bool; [[$true on success, $false otherwise]]
       }
       file_save {
          [[This function writes any changes made to the file set with
@@ -1066,7 +1066,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
 
            @since 1.7
          ]]
-         return: const(char)*;
+         return: const(char)*; [[Style]]
       }
       context_menu_clear {
          [[This clears and frees the items in a entry's contextual (longpress)
@@ -1086,7 +1086,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: bool;
+         return: bool; [[$true on success, $false otherwise]]
       }
       entry_insert {
          [[Inserts the given text into the entry at the current cursor position.
@@ -1154,7 +1154,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: bool;
+         return: bool; [[$true on success, $false otherwise]]
       }
       select_none {
          [[This drops any existing text selection within the entry.
@@ -1211,7 +1211,7 @@ class Elm.Entry (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interface,
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: bool(true);
+         return: bool(true); [[$true if empty, $false otherwise]]
       }
       markup_filter_remove {
          [[Remove a markup filter from the list

diff --git a/src/lib/elm_flip.h b/src/lib/elm_flip.h
index e07e6c6..0f2b7b2 100644 (file)
--- a/src/lib/elm_flip.h
+++ b/src/lib/elm_flip.h
@@ -5,9 +5,6 @@
  * @image html flip_inheritance_tree.png
  * @image latex flip_inheritance_tree.eps
  *
- * @image html img/widget/flip/preview-00.png
- * @image latex img/widget/flip/preview-00.eps
- *
  * This widget holds 2 content objects(Evas_Object): one on the front and one
  * on the back. It allows you to flip from front to back and vice-versa using
  * various animations.

diff --git a/src/lib/elm_flipselector.h b/src/lib/elm_flipselector.h
index 8663dbe..b407160 100644 (file)
--- a/src/lib/elm_flipselector.h
+++ b/src/lib/elm_flipselector.h
@@ -5,9 +5,6 @@
  * @image html flipselector_inheritance_tree.png
  * @image latex flipselector_inheritance_tree.eps
  *
- * @image html img/widget/flipselector/preview-00.png
- * @image latex img/widget/flipselector/preview-00.eps
- *
  * A flip selector is a widget to show a set of @b text items, one
  * at a time, with the same sheet switching style as the @ref Elm_Clock
  * "clock" widget, when one changes the current displaying sheet

diff --git a/src/lib/elm_focus.h b/src/lib/elm_focus.h
index 1f185ae..62f2b30 100644 (file)
--- a/src/lib/elm_focus.h
+++ b/src/lib/elm_focus.h
@@ -167,6 +167,7 @@ EAPI void                 elm_object_focus_custom_chain_unset(Evas_Object *obj);
  * Get custom focus chain
  *
  * @param obj The container object
+ * @return Chain of objects to pass focus.
  * @ingroup Elm_Focus
  *
  * @if MOBILE @since_tizen 2.3

diff --git a/src/lib/elm_gen.h b/src/lib/elm_gen.h
index 6d43429..e62c98a 100644 (file)
--- a/src/lib/elm_gen.h
+++ b/src/lib/elm_gen.h
@@ -101,13 +101,19 @@ struct _Elm_Gen_Item_Class
 #define ELM_GEN_ITEM_CLASS_VERSION 3
 #define ELM_GEN_ITEM_CLASS_HEADER ELM_GEN_ITEM_CLASS_VERSION, 0, 0
 
+/** Glob matching bitfiled flags.
+ *
+ * @since 1.11
+ *
+ * @ingroup Elm_Glob
+ */
 typedef enum
 {
    ELM_GLOB_MATCH_NO_ESCAPE = (1 << 0), /**< Treat backslash as an ordinary character instead of escape */
    ELM_GLOB_MATCH_PATH = (1 << 1), /**< Match a slash in string only with a slash in pattern and not by an asterisk (*) or a question mark (?) metacharacter, nor by a bracket expression ([]) containing a slash. */
    ELM_GLOB_MATCH_PERIOD = (1 << 2), /**< Leading  period in string has to be matched exactly by a period in pattern. A period is considered to be leading if it is the first character in string, or if both ELM_GLOB_MATCH_PATH is set and the period immediately follows a slash. */
    ELM_GLOB_MATCH_NOCASE = (1 << 3) /**< The pattern is matched case-insensitively. */
-} Elm_Glob_Match_Flags; /**< Glob matching bitfiled flags. @since 1.11 */
+} Elm_Glob_Match_Flags;
 
 /**
  * @}

diff --git a/src/lib/elm_genlist.eo b/src/lib/elm_genlist.eo
index f103763..6fcf82a 100644 (file)
--- a/src/lib/elm_genlist.eo
+++ b/src/lib/elm_genlist.eo
@@ -382,7 +382,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
               \@elseif WEARABLE \@since_tizen 2.3.1
               \@endif
             ]]
-            return: free(own(list<Elm_Gen_Item *> *), eina_list_free) @warn_unused;
+            return: free(own(list<Elm_Gen_Item *> *), eina_list_free) @warn_unused; [[List of realized items]]
          }
       }
       @property selected_items {
@@ -404,7 +404,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
               \@elseif WEARABLE \@since_tizen 2.3.1
               \@endif
             ]]
-            return: const(list<Elm.Widget_Item *>)*;
+            return: const(list<Elm.Widget_Item *>)*; [[List of selected items]]
          }
       }
       @property last_item {
@@ -417,7 +417,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
               \@elseif WEARABLE \@since_tizen 2.3.1
               \@endif
             ]]
-            return: Elm.Widget_Item *;
+            return: Elm.Widget_Item *; [[Last item in list]]
          }
       }
       item_insert_before {
@@ -430,7 +430,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: Elm.Widget_Item *;
+         return: Elm.Widget_Item *; [[Handle to inserted item]]
          params {
             @in itc: const(Elm_Genlist_Item_Class)*; [[The item class for the item.]]
             @in data: const(void)*; [[The item data.]]
@@ -466,7 +466,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: Elm.Widget_Item *;
+         return: Elm.Widget_Item *; [[Handle to inserted item]]
          params {
             @in itc: const(Elm_Genlist_Item_Class)*; [[The item class for the item.]]
             @in data: const(void)*; [[The item data.]]
@@ -494,7 +494,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: Elm.Widget_Item *;
+         return: Elm.Widget_Item *; [[Item at position]]
          params {
             @in x: Evas.Coord; [[The input x coordinate.]]
             @in y: Evas.Coord; [[The input y coordinate.]]
@@ -535,7 +535,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: uint;
+         return: uint; [[Count of items passing the filter]]
       }
       item_prepend {
          [[Prepend a new item in a given genlist widget.
@@ -547,7 +547,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: Elm.Widget_Item *;
+         return: Elm.Widget_Item *; [[Handle to prepended item]]
          params {
             @in itc: const(Elm_Genlist_Item_Class)*; [[The item class for the item.]]
             @in data: const(void)*; [[The item data.]]
@@ -577,7 +577,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: Elm.Widget_Item *;
+         return: Elm.Widget_Item *; [[Handle to appended item]]
          params {
             @in itc: const(Elm_Genlist_Item_Class)*; [[The item class for the item.]]
             @in data: const(void)*; [[The item data.]]
@@ -598,7 +598,7 @@ class Elm.Genlist (Elm.Layout, Elm_Interface_Scrollable, Evas.Clickable_Interfac
            \@elseif WEARABLE \@since_tizen 2.3.1
            \@endif
          ]]
-         return: Elm.Widget_Item *;
+         return: Elm.Widget_Item *; [[Handle to inserted item]]
          params {
             @in itc: const(Elm_Genlist_Item_Class)*; [[The item class for the item.]]
             @in data: const(void)*; [[The item data.]]

diff --git a/src/lib/elm_genlist.h b/src/lib/elm_genlist.h
index afe345c..cf5340a 100644 (file)
--- a/src/lib/elm_genlist.h
+++ b/src/lib/elm_genlist.h
@@ -5,8 +5,6 @@
  * @image html genlist_inheritance_tree.png
  * @image latex genlist_inheritance_tree.eps
  *
- * @image html img/widget/genlist/preview-00.png
- * @image latex img/widget/genlist/preview-00.eps
  * @image html img/genlist.png
  * @image latex img/genlist.eps
  *
@@ -89,25 +87,9 @@
  * available item styles:
  * - default
  * - default_style - The text part is a textblock
- *
- * @image html img/widget/genlist/preview-04.png
- * @image latex img/widget/genlist/preview-04.eps
- *
  * - double_label
- *
- * @image html img/widget/genlist/preview-01.png
- * @image latex img/widget/genlist/preview-01.eps
- *
  * - icon_top_text_bottom
- *
- * @image html img/widget/genlist/preview-02.png
- * @image latex img/widget/genlist/preview-02.eps
- *
  * - group_index
- *
- * @image html img/widget/genlist/preview-03.png
- * @image latex img/widget/genlist/preview-03.eps
- *
  * - one_icon - Only 1 icon (left) (since 1.7)
  * - end_icon - Only 1 icon (at end/right) (since 1.7)
  * - no_icon - No icon (at end/right) (since 1.7)

diff --git a/src/lib/elm_grid.eo b/src/lib/elm_grid.eo
index b265444..312be5b 100644 (file)
--- a/src/lib/elm_grid.eo
+++ b/src/lib/elm_grid.eo
@@ -38,7 +38,7 @@ class Elm.Grid (Elm.Widget)
               \@elseif WEARABLE \@since_tizen 2.3.1
               \@endif
             ]]
-            return: free(own(list<Evas.Object *> *), eina_list_free) @warn_unused;
+            return: free(own(list<Evas.Object *> *), eina_list_free) @warn_unused; [[List of children]]
          }
       }
       clear {

diff --git a/src/lib/elm_icon.h b/src/lib/elm_icon.h
index 76a1a74..4546387 100644 (file)
--- a/src/lib/elm_icon.h
+++ b/src/lib/elm_icon.h
@@ -5,9 +5,6 @@
  * @image html icon_inheritance_tree.png
  * @image latex icon_inheritance_tree.eps
  *
- * @image html img/widget/icon/preview-00.png
- * @image latex img/widget/icon/preview-00.eps
- *
  * An icon object is used to display standard icon images ("delete",
  * "edit", "arrows", etc.) or images coming from a custom file (PNG,
  * JPG, EDJE, etc.), on icon contexts.

diff --git a/src/lib/elm_image.h b/src/lib/elm_image.h
index 2927640..fb0d315 100644 (file)
--- a/src/lib/elm_image.h
+++ b/src/lib/elm_image.h
@@ -5,9 +5,6 @@
  * @image html image_inheritance_tree.png
  * @image latex image_inheritance_tree.eps
  *
- * @image html img/widget/image/preview-00.png
- * @image latex img/widget/image/preview-00.eps
- *
  * An Elementary image object is a direct realization of
  * @ref elm-image-class, and it allows one to load and display an @b image
  * file on it, be it from a disk file or from a memory

diff --git a/src/lib/elm_image_legacy.h b/src/lib/elm_image_legacy.h
index c54759d..774f551 100644 (file)
--- a/src/lib/elm_image_legacy.h
+++ b/src/lib/elm_image_legacy.h
@@ -161,6 +161,7 @@ EAPI Eina_Bool        elm_image_mmap_set(Evas_Object *obj, const Eina_File *file
  * @ingroup Elm_Image
  * @since 1.7
  *
+ * @param obj The image object
  * @param[in] play @c EINA_TRUE to start the animation, @c EINA_FALSE
 otherwise. Default is @c EINA_FALSE.
  *
@@ -173,6 +174,7 @@ EAPI void             elm_image_animated_play_set(Evas_Object *obj, Eina_Bool pl
 /**
  * Get whether an image object is under animation or not.
  *
+ * @param obj The image object
  * @return @c EINA_TRUE, if the image is being animated, @c EINA_FALSE
  * otherwise.
  *
@@ -204,6 +206,7 @@ EAPI Eina_Bool        elm_image_animated_play_get(const Evas_Object *obj);
  * @ingroup Elm_Image
  * @since 1.7
  *
+ * @param obj The image object
  * @param[in] anim @c EINA_TRUE if the object is to animate itself,
  * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
  *
@@ -217,6 +220,7 @@ EAPI void             elm_image_animated_set(Evas_Object *obj, Eina_Bool anim);
  *
  * Get whether an image object has animation enabled or not.
  *
+ * @param obj The image object
  * @return @c EINA_TRUE if the image has animation enabled,
  * @c EINA_FALSE otherwise.
  *
@@ -257,6 +261,9 @@ EAPI Eina_Bool        elm_image_animated_available_get(const Evas_Object *obj);
 /**
  * @brief Enable asynchronous file I/O for elm_image_file_set.
  *
+ * @param obj The image object
+ * @param[in] async @ true will make elm_image_file_set() an asynchronous operation
+ *
  * If @c true, this will make elm_image_file_set() an asynchronous operation.
  * Use of this function is not recommended and the standard EO-based
  * asynchronous I/O API should be preferred instead.

diff --git a/src/lib/elm_index.h b/src/lib/elm_index.h
index 603c166..67d9b73 100644 (file)
--- a/src/lib/elm_index.h
+++ b/src/lib/elm_index.h
@@ -5,9 +5,6 @@
  * @image html index_inheritance_tree.png
  * @image latex index_inheritance_tree.eps
  *
- * @image html img/widget/index/preview-00.png
- * @image latex img/widget/index/preview-00.eps
- *
  * An index widget gives you an index for quick access to whichever
  * group of other UI items one might have. It's a list of text
  * items (usually letters, for alphabetically ordered access).

diff --git a/src/lib/elm_object.h b/src/lib/elm_object.h
index d233dbd..37599ee 100644 (file)
--- a/src/lib/elm_object.h
+++ b/src/lib/elm_object.h
@@ -620,6 +620,7 @@ EAPI Eina_Bool   elm_object_orientation_mode_disabled_get(const Evas_Object *obj
  *
  * @param obj The object
  * @param part The object's part name to register
+ * @return Access object working for the part object
  *
  * @ingroup Elm_General
  *
@@ -636,6 +637,7 @@ EAPI Evas_Object *elm_object_part_access_register(Evas_Object *obj, const char *
  *
  * @param obj The object
  * @param part The object's part name to get access object
+ * @return The access object which is registered to part
  *
  * @ingroup Elm_General
  *
@@ -743,6 +745,7 @@ EAPI const char* elm_object_scroll_item_valign_get(const Evas_Object *obj);
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -764,6 +767,7 @@ EAPI Eina_Bool        elm_color_class_color_set(const char *color_class, int r,
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -787,6 +791,7 @@ EAPI Eina_Bool        elm_color_class_color_get(const char *color_class, int *r,
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -810,6 +815,7 @@ EAPI Eina_Bool        elm_color_class_color2_set(const char *color_class, int r,
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -833,6 +839,7 @@ EAPI Eina_Bool        elm_color_class_color2_get(const char *color_class, int *r
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -856,6 +863,7 @@ EAPI Eina_Bool        elm_color_class_color3_set(const char *color_class, int r,
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -896,6 +904,7 @@ EAPI void             elm_color_class_del(const char *color_class);
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -918,6 +927,7 @@ EAPI Eina_Bool        elm_object_color_class_color_set(Evas_Object *obj, const c
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -942,6 +952,7 @@ EAPI Eina_Bool        elm_object_color_class_color_get(Evas_Object *obj, const c
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -966,6 +977,7 @@ EAPI Eina_Bool        elm_object_color_class_color2_set(Evas_Object *obj, const
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -990,6 +1002,7 @@ EAPI Eina_Bool        elm_object_color_class_color2_get(Evas_Object *obj, const
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -1014,6 +1027,7 @@ EAPI Eina_Bool        elm_object_color_class_color3_set(Evas_Object *obj, const
  * @param[in] g The intensity of the green color.
  * @param[in] b The intensity of the blue color.
  * @param[in] a The alpha value.
+ * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
  * @since 1.19
  *
@@ -1048,6 +1062,7 @@ EAPI void             elm_object_color_class_del(Evas_Object *obj, const char *c
  * Clearing color classes will revert the color of all parts to the values
  * defined by elm_color_class_set() or the theme file.]]
  *
+ * @param obj The object to query.
  * @ingroup Elm_General
  *
  * @if MOBILE @since_tizen 3.0