tasn pushed a commit to branch master.
http://git.enlightenment.org/core/elementary.git/commit/?id=eb4ffb69e4d7cf55d5aa0629e1f907fa0a1b8d05
commit eb4ffb69e4d7cf55d5aa0629e1f907fa0a1b8d05
Author: Tom Hacohen <t...@stosb.com>
Date: Fri Aug 7 14:10:49 2015 +0100
Label: migrate docs.
---
src/lib/elm_label.eo | 175 +++++++++++++++------------------------------------
1 file changed, 49 insertions(+), 126 deletions(-)
diff --git a/src/lib/elm_label.eo b/src/lib/elm_label.eo
index 4ea399c..9f18be1 100644
--- a/src/lib/elm_label.eo
+++ b/src/lib/elm_label.eo
@@ -13,186 +13,109 @@ class Elm.Label (Elm.Layout)
eo_prefix: elm_obj_label;
methods {
@property wrap_width {
- set {
- /*@
- @brief Set wrap width of the label
-
- This function sets the maximum width size hint of the label.
+ [[Control wrap width of the label
- @warning This is only relevant if the label is inside a container.
+ This function sets the maximum width size hint of the label.
- @ingroup Label */
+ Warning: This is only relevant if the label is inside a container.]]
+ set {
}
get {
- /*@
- @brief Get wrap width of the label
-
- @return The wrap width in pixels at a minimum where words need to
wrap
-
- @see elm_label_wrap_width_set()
-
- @ingroup Label */
}
values {
- w: Evas.Coord; /*@ The wrap width in pixels at a minimum where
words need to wrap */
+ w: Evas.Coord; [[The wrap width in pixels at a minimum where words
need to wrap]]
}
}
@property slide_speed {
- set {
- /*@
- @brief Set the slide speed of the label
+ [[Control the slide speed of the label
- @see elm_label_slide_duration_set()
+ Note: If you set the duration of the slide using
@.slide_duration.set
+ you cannot get the correct speed using this function until the label
+ is actually rendered and resized.
- @ingroup Label */
+ See @.slide_duration.set]]
+ set {
}
get {
- /*@
- @brief Get the slide speed of the label
-
- @return The slide animation speed in px per seconds
-
- @note If you set the duration of the slide using
elm_label_slide_duration_set()
- you cannot get the correct speed using this function until the
label
- is actually rendered and resized.
-
- @see elm_label_slide_speed_set()
-
- @ingroup Label */
}
values {
- speed: double; /*@ The speed of the slide animation in px per
seconds */
+ speed: double; [[The speed of the slide animation in px per
seconds]]
}
}
@property slide_mode {
- set {
- /*@
- @brief Set the slide mode of the label widget.
+ [[Control the slide mode of the label widget.
- elm_label_slide_mode_set() changes label slide mode.
- By default, slide mode is none. Possible values for $mode are:
- @li #ELM_LABEL_SLIDE_MODE_NONE - no slide effect
- @li #ELM_LABEL_SLIDE_MODE_AUTO - slide only if the label area is
bigger than
- the text width length
- @li #ELM_LABEL_SLIDE_MODE_ALWAYS -slide always
+ By default, slide mode is none. Possible values for $mode are:
+ @Elm.Label.Slide_Mode.none - no slide effect
+ @Elm.Label.Slide_Mode.auto - slide only if the label area is bigger
than
+ the text width length
+ @Elm.Label.Slide_Mode.always - slide always
- @warning #ELM_LABEL_SLIDE_MODE_AUTO, #ELM_LABEL_SLIDE_MODE_ALWAYS
only work
- with the themes "slide_short", "slide_long" and "slide_bounce".
- @warning #ELM_LABEL_SLIDE_MODE_AUTO, #ELM_LABEL_SLIDE_MODE_ALWAYS
don't work
- if the line wrap(elm_label_line_wrap_set()) or
- ellipsis(elm_label_ellipsis_set()) is set.
+ Warning: @Elm.Label.Slide_Mode.auto, @Elm.Label.Slide_Mode.always
only work
+ with the themes "slide_short", "slide_long" and "slide_bounce".
+ Warning: @Elm.Label.Slide_Mode.auto, @Elm.Label.Slide_Mode.always
don't work
+ if the line wrap(elm_label_line_wrap_set()) or
+ ellipsis(elm_label_ellipsis_set()) is set.
- @see elm_label_slide_mode_get().
- @since 1.8
-
- @ingroup Label */
+ @since 1.8]]
+ set {
}
get {
- /*@
- @brief Get the slide mode of the label widget.
-
- @return The slide mode
-
- @see elm_label_slide_mode_set()
- @since 1.8
-
- @ingroup Label */
}
values {
- mode: Elm.Label.Slide_Mode; /*@ The slide mode */
+ mode: Elm.Label.Slide_Mode; [[The slide mode]]
}
}
@property slide_duration {
- set {
- /*@
- @brief Set the slide duration of the label
-
- @see elm_label_slide_speed_set()
+ [[Control the slide duration of the label
- @ingroup Label */
+ Note: If you set the speed of the slide using @.slide_speed.set
+ you cannot get the correct duration using this function until the
label
+ is actually rendered and resized.]]
+ set {
}
get {
- /*@
- @brief Get the slide duration of the label
-
- @return The duration time in moving text from slide begin position
to slide end position
-
- @note If you set the speed of the slide using
elm_label_slide_speed_set()
- you cannot get the correct duration using this function until the
label
- is actually rendered and resized.
-
- @see elm_label_slide_duration_set()
-
- @ingroup Label */
}
values {
- duration: double; /*@ The duration in seconds in moving text from
slide begin position
- to slide end position */
+ duration: double; [[The duration in seconds in moving text from
slide begin position to slide end position]]
}
}
@property line_wrap {
- set {
- /*@
- @brief Set the wrapping behavior of the label
-
- By default no wrapping is done. Possible values for $wrap are:
- @li #ELM_WRAP_NONE - No wrapping
- @li #ELM_WRAP_CHAR - wrap between characters
- @li #ELM_WRAP_WORD - wrap between words
- @li #ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
+ [[Control the wrapping behavior of the label
- @ingroup Label */
+ By default no wrapping is done. Possible values for $wrap are:
+ $ELM_WRAP_NONE - No wrapping
+ $ELM_WRAP_CHAR - wrap between characters
+ $ELM_WRAP_WORD - wrap between words
+ $ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap]]
+ set {
}
get {
- /*@
- @brief Get the wrapping behavior of the label
-
- @return Wrap type
-
- @see elm_label_line_wrap_set()
-
- @ingroup Label */
}
values {
- wrap: Elm.Wrap.Type; /*@ To wrap text or not */
+ wrap: Elm.Wrap.Type; [[To wrap text or not]]
}
}
@property ellipsis {
- set {
- /*@
- @brief Set the ellipsis behavior of the label
-
- If set to true and the text doesn't fit in the label an
ellipsis("...")
- will be shown at the end of the widget.
+ [[Control the ellipsis behavior of the label
- @warning This doesn't work with slide(elm_label_slide_set()) or if
the
- chosen wrap method was #ELM_WRAP_WORD.
+ If set to true and the text doesn't fit in the label an
ellipsis("...")
+ will be shown at the end of the widget.
- @ingroup Label */
+ Warning This doesn't work with slide(elm_label_slide_set()) or if
the
+ chosen wrap method was $ELM_WRAP_WORD.]]
+ set {
}
get {
- /*@
- @brief Get the ellipsis behavior of the label
-
- @return If true, an ellipsis will be shown at the end of the label
area.
-
- @see elm_label_ellipsis_set()
-
- @ingroup Label */
}
values {
- ellipsis: bool; /*@ To ellipsis text or not */
+ ellipsis: bool; [[To ellipsis text or not]]
}
}
slide_go {
- /*@
- @brief Start slide effect.
-
- @see elm_label_slide_mode_set()
- @since 1.8
-
- @ingroup Label */
+ [[Start slide effect.
+ See @.slide_mode.set.]]
}
}
implements {
--
