fomatting of headers -> fixup. and documentation fixing.
[framework/uifw/elementary.git] / src / lib / elm_scale.h
index c114d38..b12dcfd 100644 (file)
@@ -1,69 +1,70 @@
-   /**
   * @defgroup Scaling Widget Scaling
   *
   * Different widgets can be scaled independently. These functions
   * allow you to manipulate this scaling on a per-widget basis. The
   * object and all its children get their scaling factors multiplied
   * by the scale factor set. This is multiplicative, in that if a
   * child also has a scale size set it is in turn multiplied by its
   * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
   * double size, @c 0.5 is half, etc.
   *
   * @ref general_functions_example_page "This" example contemplates
   * some of these functions.
   */
+/**
+ * @defgroup Scaling Widget Scaling
+ *
+ * Different widgets can be scaled independently. These functions
+ * allow you to manipulate this scaling on a per-widget basis. The
+ * object and all its children get their scaling factors multiplied
+ * by the scale factor set. This is multiplicative, in that if a
+ * child also has a scale size set it is in turn multiplied by its
+ * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
+ * double size, @c 0.5 is half, etc.
+ *
+ * @ref general_functions_example_page "This" example contemplates
+ * some of these functions.
+ */
 
-   /**
   * Get the global scaling factor
   *
   * This gets the globally configured scaling factor that is applied to all
   * objects.
   *
   * @return The scaling factor
   * @ingroup Scaling
   */
-   EAPI double       elm_scale_get(void);
+/**
+ * Get the global scaling factor
+ *
+ * This gets the globally configured scaling factor that is applied to all
+ * objects.
+ *
+ * @return The scaling factor
+ * @ingroup Scaling
+ */
+EAPI double elm_scale_get(void);
 
-   /**
   * Set the global scaling factor
   *
   * This sets the globally configured scaling factor that is applied to all
   * objects.
   *
   * @param scale The scaling factor to set
   * @ingroup Scaling
   */
-   EAPI void         elm_scale_set(double scale);
+/**
+ * Set the global scaling factor
+ *
+ * This sets the globally configured scaling factor that is applied to all
+ * objects.
+ *
+ * @param scale The scaling factor to set
+ * @ingroup Scaling
+ */
+EAPI void   elm_scale_set(double scale);
 
-   /**
   * Set the global scaling factor for all applications on the display
   *
   * This sets the globally configured scaling factor that is applied to all
   * objects for all applications.
   * @param scale The scaling factor to set
   * @ingroup Scaling
   */
-   // XXX: deprecate and replace with elm_config_all_flush()
-   EAPI void         elm_scale_all_set(double scale);
+/**
+ * Set the global scaling factor for all applications on the display
+ *
+ * This sets the globally configured scaling factor that is applied to all
+ * objects for all applications.
+ * @param scale The scaling factor to set
+ * @ingroup Scaling
+ */
+// XXX: deprecate and replace with elm_config_all_flush()
+EAPI void   elm_scale_all_set(double scale);
 
-   /**
-    * Set the scaling factor for a given Elementary object
-    *
-    * @param obj The Elementary to operate on
-    * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
-    * no scaling)
-    *
-    * @ingroup Scaling
-    */
-   EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
-
-   /**
-    * Get the scaling factor for a given Elementary object
-    *
-    * @param obj The object
-    * @return The scaling factor set by elm_object_scale_set()
-    *
-    * @ingroup Scaling
-    */
-   EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+/**
+ * Set the scaling factor for a given Elementary object
+ *
+ * @param obj The Elementary to operate on
+ * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
+ * no scaling)
+ *
+ * @ingroup Scaling
+ */
+EAPI void
+            elm_object_scale_set(Evas_Object *obj, double scale)
+EINA_ARG_NONNULL(1);
 
+/**
+ * Get the scaling factor for a given Elementary object
+ *
+ * @param obj The object
+ * @return The scaling factor set by elm_object_scale_set()
+ *
+ * @ingroup Scaling
+ */
+EAPI double elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);