From: Mike McCormack <mj.mccormack@samsung.com>
Date: Fri, 4 Nov 2011 00:24:14 +0000 (+0900)
Subject: Merge documentation on UI mirroring
X-Git-Tag: REBUILDD-ARMEL-67367~106
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ced50e94240a4825079a30ca600421f82c11e64e;p=framework%2Fuifw%2Felementary.git

Merge documentation on UI mirroring
---

diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in
index 5c46b86..47f0a08 100644
--- a/src/lib/Elementary.h.in
+++ b/src/lib/Elementary.h.in
@@ -1487,10 +1487,58 @@ extern "C" {
     * @}
     */
 
+   /**
+    * @defgroup UI-Mirroring Selective Widget mirroring
+    *
+    * These functions allow you to set ui-mirroring on specific
+    * widgets or the whole interface. Widgets can be in one of two
+    * modes, automatic and manual.  Automatic means they'll be changed
+    * according to the system mirroring mode and manual means only
+    * explicit changes will matter. You are not supposed to change
+    * mirroring state of a widget set to automatic, will mostly work,
+    * but the behavior is not really defined.
+    *
+    * @{
+    */
+
+   /**
+    * Get the system mirrored mode. This determines the default mirrored mode
+    * of widgets.
+    *
+    * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
+    */
    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+   /**
+    * Set the system mirrored mode. This determines the default mirrored mode
+    * of widgets.
+    *
+    * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
+    */
    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
+
+   /**
+    * Returns the widget's mirrored mode setting.
+    *
+    * @param obj The widget.
+    * @return mirrored mode setting of the object.
+    *
+    **/
    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+   /**
+    * Sets the widget's mirrored mode setting.
+    * When widget in automatic mode, it follows the system mirrored mode set by
+    * elm_mirrored_set().
+    * @param obj The widget.
+    * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
+    */
    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
+
+   /**
+    * @}
+    */
+
    /**
     * Set the style to use by a widget
     *