summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2018-01-17 13:22:55 +0900
committerJaehyun Cho <jae_hyun.cho@samsung.com>2018-01-17 13:22:56 +0900
commitecaec8b0afd258db37bc40e21fbe188b226a8a4f (patch)
treefbdcccd5a9a722b2da35621ffbbc98daa4b1829b
parent2bad31bdc420b619f3ae02b41549444dea15e26e (diff)
docs: Fix wrong doxygen expressions.
Summary: This patch fixes wrong doxygen expressions in elm_box legacy API reference doxygen. Test Plan: documentation Reviewers: cedric, raster, jpeg, stefan, Jaehyun_Cho Differential Revision: https://phab.enlightenment.org/D5743
-rw-r--r--src/lib/elementary/elm_bg_legacy.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/lib/elementary/elm_bg_legacy.h b/src/lib/elementary/elm_bg_legacy.h
index 8110c80d0f..394d96a24c 100644
--- a/src/lib/elementary/elm_bg_legacy.h
+++ b/src/lib/elementary/elm_bg_legacy.h
@@ -18,7 +18,7 @@
18 } Elm_Bg_Option; 18 } Elm_Bg_Option;
19 19
20/** 20/**
21 * Add a new background to the parent 21 * @brief Adds a new background to the parent
22 * 22 *
23 * @param parent The parent object 23 * @param parent The parent object
24 * @return The new object or @c NULL if it cannot be created 24 * @return The new object or @c NULL if it cannot be created
@@ -28,7 +28,7 @@
28EAPI Evas_Object *elm_bg_add(Evas_Object *parent); 28EAPI Evas_Object *elm_bg_add(Evas_Object *parent);
29 29
30/** 30/**
31 * Set the color on a given background widget 31 * @brief Sets the color on a given background widget
32 * 32 *
33 * @param obj The background object handle 33 * @param obj The background object handle
34 * @param r The red color component's value 34 * @param r The red color component's value
@@ -51,7 +51,7 @@ EAPI Evas_Object *elm_bg_add(Evas_Object *parent);
51EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b); 51EAPI void elm_bg_color_set(Evas_Object *obj, int r, int g, int b);
52 52
53/** 53/**
54 * Get the color set on a given background widget 54 * @brief Gets the color set on a given background widget
55 * 55 *
56 * @param obj The background object handle 56 * @param obj The background object handle
57 * @param r Where to store the red color component's value 57 * @param r Where to store the red color component's value
@@ -68,7 +68,7 @@ EAPI void elm_bg_color_set(Evas_Object *obj, int r, int
68EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b); 68EAPI void elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b);
69 69
70/** 70/**
71 * Set the file (image or edje collection) to give life for the 71 * @brief Sets the file (image or edje collection) to give life for the
72 * background 72 * background
73 * 73 *
74 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise 74 * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
@@ -98,7 +98,7 @@ EAPI void elm_bg_color_get(const Evas_Object *obj, int *
98EAPI Eina_Bool elm_bg_file_set(Eo *obj, const char *file, const char *group); 98EAPI Eina_Bool elm_bg_file_set(Eo *obj, const char *file, const char *group);
99 99
100/** 100/**
101 * Get the file (image or edje collection) set on a given background 101 * @brief Gets the file (image or edje collection) set on a given background
102 * widget 102 * widget
103 * 103 *
104 * @note Use @c NULL pointers on the file components you're not 104 * @note Use @c NULL pointers on the file components you're not
@@ -113,7 +113,7 @@ EAPI Eina_Bool elm_bg_file_set(Eo *obj, const char *file, const char *group);
113EAPI void elm_bg_file_get(const Eo *obj, const char **file, const char **group); 113EAPI void elm_bg_file_get(const Eo *obj, const char **file, const char **group);
114 114
115/** 115/**
116 * Set the mode of display for a given background widget's image 116 * @brief Sets the mode of display for a given background widget's image
117 * 117 *
118 * This sets how the background widget will display its image. This 118 * This sets how the background widget will display its image. This
119 * will only work if the elm_bg_file_set() was previously called with 119 * will only work if the elm_bg_file_set() was previously called with
@@ -129,7 +129,7 @@ EAPI void elm_bg_file_get(const Eo *obj, const char **file, const char **group);
129EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option); 129EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option);
130 130
131/** 131/**
132 * Get the mode of display of a given background widget's image 132 * @brief Gets the mode of display of a given background widget's image
133 * 133 *
134 * @return The background option Elm.Bg.Option Default is #Elm_Bg_SCALE. 134 * @return The background option Elm.Bg.Option Default is #Elm_Bg_SCALE.
135 * 135 *
@@ -140,7 +140,7 @@ EAPI void elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option);
140EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj); 140EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj);
141 141
142/** 142/**
143 * Set the size of the pixmap representation of the image set on a 143 * @brief Sets the size of the pixmap representation of the image set on a
144 * given background widget. 144 * given background widget.
145 * 145 *
146 * @warning: This function just makes sense if an image file was set on 146 * @warning: This function just makes sense if an image file was set on