q66 pushed a commit to branch master.
http://git.enlightenment.org/core/elementary.git/commit/?id=26db090fbb376032431e40e76f45097784b0610b
commit 26db090fbb376032431e40e76f45097784b0610b
Author: Daniel Kolesa <d.kol...@osg.samsung.com>
Date: Thu Jul 2 14:47:56 2015 +0100
notify: convert docs
---
src/lib/elm_notify.eo | 80 +++++++++++++++++++++------------------------------
1 file changed, 33 insertions(+), 47 deletions(-)
diff --git a/src/lib/elm_notify.eo b/src/lib/elm_notify.eo
index a3766c3..23b21ec 100644
--- a/src/lib/elm_notify.eo
+++ b/src/lib/elm_notify.eo
@@ -4,82 +4,68 @@ class Elm.Notify (Elm.Container)
methods {
@property align {
set {
- /*@
- @brief Set the alignment of the notify object
+ [[Set the alignment of the notify object
- Sets the alignment in which the notify will appear in its parent.
+ Sets the alignment in which the notify will appear in its parent.
- @note To fill the notify box in the parent area, please pass the
- #ELM_NOTIFY_ALIGN_FILL to @p horizontal, @p vertical.
+ Note: To fill the notify box in the parent area, please pass the
+ ELM_NOTIFY_ALIGN_FILL to horizontal and vertical.
- @since 1.8
- @ingroup Notify */
+ @since 1.8
+ ]]
}
get {
- /*@
- @brief Get the alignment of the notify object
- @see elm_notify_align_set()
+ [[Get the alignment of the notify object
- @since 1.8
- @ingroup Notify */
+ @since 1.8
+ ]]
}
values {
- horizontal: double; /*@ The horizontal alignment of the
notification */
- vertical: double; /*@ The vertical alignment of the notification */
+ horizontal: double; [[The horizontal alignment of the
notification]]
+ vertical: double; [[The vertical alignment of the notification]]
}
}
@property allow_events {
set {
- /*@
- @brief Sets whether events should be passed to by a click outside
- its area.
+ [[Sets whether events should be passed to by a click outside
+ its area.
- When true if the user clicks outside the window the events will be
caught
- by the others widgets, else the events are blocked.
+ 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 */
+ Note: The default value is true.
+ ]]
}
get {
- /*@
- @brief Return true if events are allowed below the notify object
- @see elm_notify_allow_events_set()
-
- @ingroup Notify */
+ [[Return true if events are allowed below the notify object.]]
}
values {
- allow: bool; /*@ EINA_TRUE If events are allowed, otherwise not */
+ allow: bool; [[true if events are allowed, otherwise false]]
}
}
@property timeout {
set {
- /*@
- @brief Set the time interval after which the notify window is
going to be
- hidden.
+ [[Set the time interval after which the notify window is going to
+ be hidden.
- This function sets a timeout and starts the timer controlling when
the
- notify is hidden. Since calling evas_object_show() on a notify
restarts
- the timer controlling when the notify is hidden, setting this
before the
- notify is shown will in effect mean starting the timer when the
notify is
- shown.
+ This function sets a timeout and starts the timer controlling
+ when the notify is hidden. Since calling evas_object_show() on
+ a notify restarts the timer controlling when the notify is
+ hidden, setting this before the notify is shown will in effect
+ mean starting the timer when the notify is shown.
- @note Set a value <= 0.0 to disable a running timer.
+ Note: Set a value <= 0.0 to disable a running timer.
- @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 */
+ Note: If the value > 0.0 and the notify is previously visible,
+ the timer will be started with this value, canceling any running
+ timer.
+ ]]
}
get {
- /*@
- @brief Return the timeout value (in seconds)
- @see elm_notify_timeout_set()
-
- @ingroup Notify */
+ [[Return the timeout value (in seconds)]]
}
values {
- timeout: double; /*@ The timeout in seconds */
+ timeout: double; [[The timeout in seconds]]
}
}
}
--
