valgrind bitches in store -> fix!
[framework/uifw/elementary.git] / src / lib / elm_progressbar.h
index 2104924..5b08d72 100644 (file)
@@ -1,5 +1,6 @@
 /**
  * @defgroup Progressbar Progress bar
+ * @ingroup Elementary
  *
  * The progress bar is a widget for visually representing the
  * progress status of a given job/task.
  * value</b>. Label, icon and unit strings/objects are @b optional
  * for progress bars.
  *
- * A progress bar may be @b inverted, in which state it gets its
- * values inverted, with high values being on the left or top and
- * low values on the right or bottom, as opposed to normally have
- * the low values on the former and high values on the latter,
- * respectively, for horizontal and vertical modes.
+ * A progress bar may be @b inverted, in which case it gets its
+ * values inverted, i.e., high values being on the left or top and
+ * low values on the right or bottom, for horizontal and vertical modes
+ * respectively.
  *
  * The @b span of the progress, as set by
  * elm_progressbar_span_size_set(), is its length (horizontally or
  * vertically), unless one puts size hints on the widget to expand
  * on desired directions, by any container. That length will be
- * scaled by the object or applications scaling factor. At any
- * point code can query the progress bar for its value with
+ * scaled by the object or applications scaling factor.
+ * Applications can query the progress bar for its value with
  * elm_progressbar_value_get().
  *
  * Available widget styles for progress bars:
  *      "pulse" effect is available)
  *
  * Default text parts of the progressbar widget that you can use for are:
- * @li "default" - Label of the progressabar
+ * @li "default" - Label of the progressbar
  *
- * Default contents parts of the progressbar widget that you can use for are:
+ * Default content parts of the progressbar widget that you can use for are:
  * @li "icon" - An icon of the progressbar
  *
  * Supported elm_object common APIs.
- * @li elm_object_part_text_set
- * @li elm_object_part_text_get
- * @li elm_object_part_content_set
- * @li elm_object_part_content_get
- * @li elm_object_part_content_unset
+ * @li @ref elm_object_part_text_set
+ * @li @ref elm_object_part_text_get
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
  *
  * Here is an example on its usage:
  * @li @ref progressbar_example
@@ -72,10 +72,10 @@ EAPI Evas_Object                 *elm_progressbar_add(Evas_Object *parent);
  *
  * By default, progress bars will display values from the low to
  * high value boundaries. There are, though, contexts in which the
- * state of progression of a given task is @b unknown.  For those,
+ * progress of a given task is @b unknown.  For such cases,
  * one can set a progress bar widget to a "pulsing state", to give
  * the user an idea that some computation is being held, but
- * without exact progress values. In the default theme it will
+ * without exact progress values. In the default theme, it will
  * animate its bar with the contents filling in constantly and back
  * to non-filled, in a loop. To start and stop this pulsing
  * animation, one has to explicitly call elm_progressbar_pulse().
@@ -195,7 +195,7 @@ EAPI Evas_Coord                   elm_progressbar_span_size_get(const Evas_Objec
  * area to be hidden completely. If not, it'll set the <b>format
  * string</b> for the units label's @b text. The units label is
  * provided a floating point value, so the units text is up display
- * at most one floating point falue. Note that the units label is
+ * at most one floating point value. Note that the units label is
  * optional. Use a format string such as "%1.2f meters" for
  * example.
  *