elm_box: add missing parameter description (upstream merged) 38/157938/1
authorJinYong Park <j4939.park@samsung.com>
Fri, 27 Oct 2017 02:43:48 +0000 (11:43 +0900)
committerJinYong Park <j4939.park@samsung.com>
Fri, 27 Oct 2017 02:44:21 +0000 (11:44 +0900)
Summary : Add missing parameter description to remove doxygen warning

Test Plan : API Doxygen Revision

https://phab.enlightenment.org/D5391

Change-Id: I0cbe075630d978859245984ee8e4440b31d115e5
Signed-off-by: JinYong Park <j4939.park@samsung.com>
src/lib/elm_box_common.h

index 0ddaa26..22a55c1 100644 (file)
@@ -19,6 +19,10 @@ typedef struct _Elm_Box_Transition Elm_Box_Transition;
 /**
  * Special layout function that animates the transition from one layout to another
  *
+ * @param obj The object.
+ * @param priv The smart object instance data.
+ * @param data Data will be passed to function.
+ *
  * Normally, when switching the layout function for a box, this will be
  * reflected immediately on screen on the next render, but it's also
  * possible to do this through an animated transition.
@@ -36,7 +40,7 @@ typedef struct _Elm_Box_Transition Elm_Box_Transition;
  *                            NULL, // data for final layout
  *                            NULL, // free function for final data
  *                            anim_end, // will be called when animation ends
- *                            NULL); // data for anim_end function\
+ *                            NULL); // data for anim_end function
  * elm_box_layout_set(box, elm_box_layout_transition, t,
  *                    elm_box_transition_free);
  * @endcode