[genlist] apply r71140 with local enhancement
[framework/uifw/elementary.git] / src / lib / elm_mirroring.h
index 27f2962..24baa48 100644 (file)
@@ -1,55 +1,59 @@
-   /**
-    * @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.
-    *
-    * @{
-    */
+/**
+ * @defgroup Mirroring Mirroring
+ * @ingroup Elementary
+ *
+ * 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.
+ *
+ * @{
+ */
 
-   EAPI Eina_Bool    elm_mirrored_get(void);
-   EAPI void         elm_mirrored_set(Eina_Bool mirrored);
+/**
+ * Get the widget's mirrored mode.
+ *
+ * @param obj The widget.
+ * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
+ *
+ * @ingroup Mirroring
+ */
+EAPI Eina_Bool elm_object_mirrored_get(const Evas_Object *obj);
 
-   /**
-    * 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 widget's mirrored mode.
+ *
+ * @param obj The widget.
+ * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
+ *
+ * @ingroup Mirroring
+ */
+EAPI void      elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored);
 
-   /**
-    * 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.
+ *
+ * @ingroup Mirroring
+ */
+EAPI Eina_Bool elm_object_mirrored_automatic_get(const Evas_Object *obj);
 
-   /**
-    * 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);
-
-   /**
-    * @}
-    */
+/**
+ * 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.
+ *
+ * @ingroup Mirroring
+ */
+EAPI void      elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic);
 
+/**
+ * @}
+ */