From: Youngbok Shin <youngb.shin@samsung.com>
Date: Wed, 25 Oct 2017 12:04:27 +0000 (+0900)
Subject: image, gesture_layer, glview: remove doxygen warnings
X-Git-Tag: submit/tizen/20171101.082936~2
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=884e2e0da8d0211601d79ea96671bb9eb16c84aa;p=platform%2Fupstream%2Felementary.git

image, gesture_layer, glview: remove doxygen warnings

- Remove warning messages caused by referencing to internal API.
- Add missing parameter descriptions.
- Put a space between ref keyword and colon character.

Change-Id: Ia5f09f68250e45b6fd7b5b16189907ca46df858a
---

diff --git a/src/lib/elm_gesture_layer_legacy.h b/src/lib/elm_gesture_layer_legacy.h
index 6cb1ddf11..3433b36c8 100644
--- a/src/lib/elm_gesture_layer_legacy.h
+++ b/src/lib/elm_gesture_layer_legacy.h
@@ -19,6 +19,7 @@ EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent);
 /**
  * This function adds a callback called during Tap + Long Tap sequence.
  *
+ * @param obj the gesture-layer object.
  * @param state state for the callback to add.
  * @param cb callback pointer
  * @param data user data for the callback.
@@ -45,6 +46,7 @@ EAPI void elm_gesture_layer_tap_longpress_cb_add(Evas_Object *obj, Elm_Gesture_S
 /**
  * This function removes a callback called during Tap + Long Tap sequence.
  *
+ * @param obj the gesture-layer object.
  * @param state state for the callback to add.
  * @param cb callback pointer
  * @param data user data for the callback.
diff --git a/src/lib/elm_glview.h b/src/lib/elm_glview.h
index 8f8a84866..2254639fb 100644
--- a/src/lib/elm_glview.h
+++ b/src/lib/elm_glview.h
@@ -11,7 +11,7 @@
  * to a surface using OpenGL APIs.
  *
  * This widget emits the following signals, besides the ones sent from
- * @ref Elm_GLView:
+ * @ref Elm_GLView :
  * - @c "focused" - when glview has received focus.
  * - @c "unfocused" - when glview has lost focus.
  * - @c "language,changed" - the program's language changed
diff --git a/src/lib/elm_icon.h b/src/lib/elm_icon.h
index 4546387ca..6bf42ee9d 100644
--- a/src/lib/elm_icon.h
+++ b/src/lib/elm_icon.h
@@ -122,7 +122,7 @@
  * @li @c "media_player/stop"
  *
  * This widget emits the following signals, besides the ones sent from
- * @ref Elm_Image:
+ * @ref Elm_Image :
  * - @c "thumb,done" - elm_icon_thumb_set() has completed with success
  *                     (since 1.7)
  * - @c "thumb,error" - elm_icon_thumb_set() has failed (since 1.7)
diff --git a/src/lib/elm_image.eo b/src/lib/elm_image.eo
index 3eaeb1524..bb542f5ba 100644
--- a/src/lib/elm_image.eo
+++ b/src/lib/elm_image.eo
@@ -90,7 +90,7 @@ class Elm.Image (Elm.Widget, Efl.File, Efl.Image, Evas.Clickable_Interface,
            This function disables scaling of the elm_image widget through the
            function elm_object_scale_set(). However, this does not affect the widget
            size/resize in any way. For that effect, take a look at
-           @.resizable and @Elm.Widget.scale]]
+           @.resizable and elm_object_scale_set]]
          set {
             [[
               \@if MOBILE \@since_tizen 2.3
diff --git a/src/lib/elm_image.h b/src/lib/elm_image.h
index fb0d315ea..5873f0030 100644
--- a/src/lib/elm_image.h
+++ b/src/lib/elm_image.h
@@ -5,8 +5,7 @@
  * @image html image_inheritance_tree.png
  * @image latex image_inheritance_tree.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
+ * It allows one to load and display an @b image
  * file on it, be it from a disk file or from a memory
  * region. Exceptionally, one may also load an Edje group as the
  * contents of the image. In this case, though, most of the functions
diff --git a/src/lib/elm_image_legacy.h b/src/lib/elm_image_legacy.h
index 774f55108..b13451201 100644
--- a/src/lib/elm_image_legacy.h
+++ b/src/lib/elm_image_legacy.h
@@ -51,6 +51,7 @@ EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, con
  *
  * @ingroup Elm_Image
  *
+ * @param[in]  obj The image object
  * @param[out] file The path to file that will be used as image source
  * @param[out] group The group that the image belongs to, in case it's an
 EET (including Edje case) file. This can be used as a key inside
@@ -239,6 +240,7 @@ EAPI Eina_Bool        elm_image_animated_get(const Evas_Object *obj);
  *
  * Get whether an image object supports animation or not.
  *
+ * @param obj The image object
  * @return @c EINA_TRUE if the image supports animation,
  * @c EINA_FALSE otherwise.
  *