lets not use a string wer just freed ok?

[framework/uifw/elementary.git] / src / lib / elm_notify.h

diff --git a/src/lib/elm_notify.h b/src/lib/elm_notify.h
index d728f04..0fab742 100644 (file)
--- a/src/lib/elm_notify.h
+++ b/src/lib/elm_notify.h
@@ -1,5 +1,6 @@
 /**
  * @defgroup Notify Notify
+ * @ingroup Elementary
  *
  * @image html img/widget/notify/preview-00.png
  * @image latex img/widget/notify/preview-00.eps
@@ -13,9 +14,14 @@
  * @li "timeout" - when timeout happens on notify and it's hidden
  * @li "block,clicked" - when a click outside of the notify happens
  *
- * Default contents parts of the notify widget that you can use for are:
+ * Default content parts of the notify widget that you can use for are:
  * @li "default" - A content of the notify
  *
+ * Supported elm_object common APIs.
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
+ *
  * @ref tutorial_notify show usage of the API.
  *
  * @{
@@ -48,6 +54,8 @@ typedef enum
  *
  * @param parent The parent object
  * @return The new object or NULL if it cannot be created
+ *
+ * @ingroup Notify
  */
 EAPI Evas_Object                 *elm_notify_add(Evas_Object *parent);
 
@@ -55,10 +63,12 @@ EAPI Evas_Object                 *elm_notify_add(Evas_Object *parent);
  * @brief Set the notify parent
  *
  * @param obj The notify object
- * @param content The new parent
+ * @param parent The new parent
  *
  * Once the parent object is set, a previously set one will be disconnected
  * and replaced.
+ *
+ * @ingroup Notify
  */
 EAPI void                         elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent);
 
@@ -69,6 +79,8 @@ EAPI void                         elm_notify_parent_set(Evas_Object *obj, Evas_O
  * @return The parent
  *
  * @see elm_notify_parent_set()
+ *
+ * @ingroup Notify
  */
 EAPI Evas_Object                 *elm_notify_parent_get(const Evas_Object *obj);
 
@@ -81,6 +93,8 @@ EAPI Evas_Object                 *elm_notify_parent_get(const Evas_Object *obj);
  * Sets the position in which the notify will appear in its parent.
  *
  * @see @ref Elm_Notify_Orient for possible values.
+ *
+ * @ingroup Notify
  */
 EAPI void                         elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient);
 
@@ -91,6 +105,8 @@ EAPI void                         elm_notify_orient_set(Evas_Object *obj, Elm_No
  *
  * @see elm_notify_orient_set()
  * @see Elm_Notify_Orient
+ *
+ * @ingroup Notify
  */
 EAPI Elm_Notify_Orient            elm_notify_orient_get(const Evas_Object *obj);
 
@@ -99,7 +115,7 @@ EAPI Elm_Notify_Orient            elm_notify_orient_get(const Evas_Object *obj);
  * hidden.
  *
  * @param obj The notify object
- * @param time The timeout in seconds
+ * @param timeout The timeout in seconds
  *
  * This function sets a timeout and starts the timer controlling when the
  * notify is hidden. Since calling evas_object_show() on a notify restarts
@@ -111,6 +127,8 @@ EAPI Elm_Notify_Orient            elm_notify_orient_get(const Evas_Object *obj);
  *
  * @note If the value > 0.0 and the notify is previously visible, the
  * timer will be started with this value, canceling any running timer.
+ *
+ * @ingroup Notify
  */
 EAPI void                         elm_notify_timeout_set(Evas_Object *obj, double timeout);
 
@@ -119,6 +137,8 @@ EAPI void                         elm_notify_timeout_set(Evas_Object *obj, doubl
  * @param obj the notify object
  *
  * @see elm_notify_timeout_set()
+ *
+ * @ingroup Notify
  */
 EAPI double                       elm_notify_timeout_get(const Evas_Object *obj);
 
@@ -127,22 +147,26 @@ EAPI double                       elm_notify_timeout_get(const Evas_Object *obj)
  * its area.
  *
  * @param obj The notify object
- * @param repeats EINA_TRUE Events are repeats, else no
+ * @param allow EINA_TRUE If events are allowed, otherwise not
  *
  * When true if the user clicks outside the window the events will be caught
  * by the others widgets, else the events are blocked.
  *
  * @note The default value is EINA_TRUE.
+ *
+ * @ingroup Notify
  */
-EAPI void                         elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat);
+EAPI void                         elm_notify_allow_events_set(Evas_Object *obj, Eina_Bool allow);
 
 /**
- * @brief Return true if events are repeat below the notify object
+ * @brief Return true if events are allowed below the notify object
  * @param obj the notify object
  *
- * @see elm_notify_repeat_events_set()
+ * @see elm_notify_allow_events_set()
+ *
+ * @ingroup Notify
  */
-EAPI Eina_Bool                    elm_notify_repeat_events_get(const Evas_Object *obj);
+EAPI Eina_Bool                    elm_notify_allow_events_get(const Evas_Object *obj);
 
 /**
  * @}