From: Myoungwoon Roy, Kim <myoungwoon.kim@samsung.com>
Date: Wed, 28 Jun 2017 00:45:31 +0000 (+0900)
Subject: docs: Fix typos and some wrong expressions in elm Box API reference doxygen
X-Git-Tag: accepted/tizen/unified/20170711.181143~26
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F01%2F136001%2F2;p=platform%2Fupstream%2Felementary.git

docs: Fix typos and some wrong expressions in elm Box API reference doxygen

Change-Id: I46db38ac8b6a7121df86c103f61983bb63abccad
---

diff --git a/src/lib/elm_bg.eo b/src/lib/elm_bg.eo
index 0fb235d..bff0125 100644
--- a/src/lib/elm_bg.eo
+++ b/src/lib/elm_bg.eo
@@ -19,7 +19,7 @@ class Elm.Bg (Elm.Layout, Efl.File)
    methods {
       @property option {
          set {
-            [[Set the mode of display for a given background widget's image
+            [[Sets the mode of display for a given background widget's image
 
               This sets how the background widget will display its image. This
               will only work if the @Efl.File.file.set was previously called with
@@ -35,7 +35,7 @@ class Elm.Bg (Elm.Layout, Efl.File)
 
          }
          get {
-            [[Get the mode of display for a given background widget's image.
+            [[Gets the mode of display for a given background widget's image.
 
               See also @.option.set for more details
 
@@ -50,7 +50,7 @@ class Elm.Bg (Elm.Layout, Efl.File)
       }
       @property color {
          set {
-            [[Set the color on a given background widget
+            [[Sets the color on a given background widget
 
               This sets the color used for the background rectangle, in RGB
               format. Each color component's range is from 0 to 255.
@@ -67,7 +67,7 @@ class Elm.Bg (Elm.Layout, Efl.File)
             legacy: null; /* legacy doesn't have 'a' param */
          }
          get {
-            [[Get the color set on a given background widget
+            [[Gets the color set on a given background widget
 
               Note: Use $null pointers on the file components you're not
               interested in: they'll be ignored by the function.
@@ -87,7 +87,7 @@ class Elm.Bg (Elm.Layout, Efl.File)
       }
       @property load_size {
          set {
-            [[Set the size of the pixmap representation of the image set on a
+            [[Sets the size of the pixmap representation of the image set on a
               given background widget.
 
               Warning: This function just makes sense if an image file was set on
diff --git a/src/lib/elm_bg_legacy.h b/src/lib/elm_bg_legacy.h
index a2d461a..5a55149 100644
--- a/src/lib/elm_bg_legacy.h
+++ b/src/lib/elm_bg_legacy.h
@@ -1,5 +1,5 @@
 /**
- * Add a new background to the parent
+ * Adds a new background to the parent.
  *
  * @param parent The parent object
  * @return The new object or @c NULL if it cannot be created
@@ -13,7 +13,7 @@
 EAPI Evas_Object                 *elm_bg_add(Evas_Object *parent);
 
 /**
- * Set the color on a given background widget
+ * Sets the color on a given background widget.
  *
  * @param obj The background object handle
  * @param r The red color component's value
@@ -29,7 +29,7 @@ EAPI Evas_Object                 *elm_bg_add(Evas_Object *parent);
  *
  * @note You can reset the color by setting @p r, @p g, @p b as -1, -1, -1.
  *
- * @see elm_bg_color_get()
+ * @see elm_bg_color_get() for more details
  *
  * @ingroup Elm_Bg
  *
@@ -40,7 +40,7 @@ EAPI Evas_Object                 *elm_bg_add(Evas_Object *parent);
 EAPI void                         elm_bg_color_set(Evas_Object *obj, int r, int g, int b);
 
 /**
- * Get the color set on a given background widget
+ * Gets the color set on a given background widget.
  *
  * @param obj The background object handle
  * @param r Where to store the red color component's value
@@ -61,8 +61,8 @@ EAPI void                         elm_bg_color_set(Evas_Object *obj, int r, int
 EAPI void                         elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b);
 
 /**
- * Set the file (image or edje collection) to give life for the
- * background
+ * Sets the file (image or edje collection) to give life for the
+ * background.
  *
  * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
  *
@@ -94,8 +94,8 @@ EAPI void                         elm_bg_color_get(const Evas_Object *obj, int *
 EAPI Eina_Bool elm_bg_file_set(Eo *obj, const char *file, const char *group);
 
 /**
- * Get the file (image or edje collection) set on a given background
- * widget
+ * Gets the file (image or edje collection) set on a given background
+ * widget.
  *
  * @note Use @c NULL pointers on the file components you're not
  * interested in: they'll be ignored by the function.
@@ -111,16 +111,17 @@ EAPI Eina_Bool elm_bg_file_set(Eo *obj, const char *file, const char *group);
  */
 EAPI void elm_bg_file_get(const Eo *obj, const char **file, const char **group);
 
-// TIZEN_ONLY(20160218): Improve launching performance.
+// TIZEN_ONLY(20160218): Improves launching performance.
 /**
  * @internal
  *
- * Set the precreated object.
+ * Sets the precreated object.
  *
  * @param obj The background object
  *
  * @ingroup Elm_Bg
- * @see elm_bg_precreated_object_get()
+ *
+ * @see elm_bg_precreated_object_get() for more details
  * @since Tizen 2.4
  */
 EAPI void elm_bg_precreated_object_set(Evas_Object *obj);
@@ -128,12 +129,13 @@ EAPI void elm_bg_precreated_object_set(Evas_Object *obj);
 /**
  * @internal
  *
- * Get the precreated object.
+ * Gets the precreated object.
  *
  * @return The precreated background object
  *
  * @ingroup Elm_Bg
- * @see elm_bg_precreated_object_set()
+ *
+ * @see elm_bg_precreated_object_set() for more details
  * @since Tizen 2.4
  */
 EAPI Evas_Object *elm_bg_precreated_object_get(void);