q66 pushed a commit to branch master.
http://git.enlightenment.org/core/elementary.git/commit/?id=5c14fa2f3197a5867de1b42ce697c897c5fe13ce
commit 5c14fa2f3197a5867de1b42ce697c897c5fe13ce
Author: Vivek Ellur <vivek.el...@samsung.com>
Date: Fri Jul 24 13:43:36 2015 +0100
elm_dayselector: converted eo docs of dayselector to new format
Summary:
Converted docs of elm_dayselector.eo to the new format
Signed-off-by: Vivek Ellur <vivek.el...@samsung.com>
Reviewers: cedric, q66
Reviewed By: q66
Differential Revision: https://phab.enlightenment.org/D2863
---
src/lib/elm_dayselector.eo | 173 +++++++++++++++++++--------------------------
1 file changed, 72 insertions(+), 101 deletions(-)
diff --git a/src/lib/elm_dayselector.eo b/src/lib/elm_dayselector.eo
index 5cc6ea9..457cb7a 100644
--- a/src/lib/elm_dayselector.eo
+++ b/src/lib/elm_dayselector.eo
@@ -23,154 +23,125 @@ class Elm.Dayselector (Elm.Layout)
methods {
@property week_start {
set {
- /*@
- Set the starting day of Dayselector.
+ [[Set the starting day of Dayselector.
- @see Elm_Dayselector_Day
- @see elm_dayselector_week_start_get()
-
- @ingroup Dayselector */
+ See also @Elm.Dayselector.Day,
+ @.week_start.get.
+ ]]
}
get {
- /*@
- Get the starting day of Dayselector.
-
- @return Day from where Dayselector displays all the weekdays in
order.
-
- @see Elm_Dayselector_Day
- @see elm_dayselector_week_start_set()
+ [[Get the starting day of Dayselector.
- @ingroup Dayselector */
+ See also @Elm.Dayselector.Day,
+ @.week_start.set.
+ ]]
}
values {
- day: Elm.Dayselector.Day; /*@ Dayselector_Day the first day that
the user wants to display. */
+ day: Elm.Dayselector.Day; [[Dayselector_Day the first day that the
user wants to display.]]
}
}
@property weekend_length {
set {
- /*@
- Set the weekend length of Dayselector.
+ [[Set the weekend length of Dayselector.
- @see elm_dayselector_weekend_length_get()
-
- @ingroup Dayselector */
+ See also @.weekend_length.get.
+ ]]
}
get {
- /*@
- Get the weekend length of Dayselector.
-
- @return Number of days marked as a weekend.
-
- @see Elm_Dayselector_Day
- @see elm_dayselector_weekend_length_set()
+ [[Get the weekend length of Dayselector.
- @ingroup Dayselector */
+ See also @Elm.Dayselector.Day,
+ @.weekend_length.set.
+ ]]
}
values {
- length: uint; /*@ Weekend length, number of days as an integer. */
+ length: uint; [[Weekend length, number of days as an integer.]]
}
}
@property weekend_start {
set {
- /*@
- Set the weekend starting day of Dayselector.
+ [[Set the weekend starting day of Dayselector.
- @see Elm_Dayselector_Day
- @see elm_dayselector_weekend_start_get()
-
- @ingroup Dayselector */
+ See also @Elm.Dayselector.Day,
+ @.weekend_start.get.
+ ]]
}
get {
- /*@
- Get the weekend starting day of Dayselector.
-
- @return Elm.Dayselector.Day Day from where weekend starts.
-
- @see Elm_Dayselector_Day
- @see elm_dayselector_weekend_start_set()
+ [[Get the weekend starting day of Dayselector.
- @ingroup Dayselector */
+ See also @Elm.Dayselector.Day,
+ @.weekend_start.set.
+ ]]
}
values {
- day: Elm.Dayselector.Day; /*@ Dayselector_Day the first day from
where weekend starts. */
+ day: Elm.Dayselector.Day; [[Dayselector_Day the first day from
where weekend starts.]]
}
}
weekdays_names_set {
- /*@
- Set weekdays names to be displayed by the Dayselector.
-
- By default or if @a weekdays is @c NULL, weekdays abbreviations get
from system are displayed:
- E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
-
- The first string should be related to Sunday, the second to Monday...
-
- The usage should be like this:
- @code
- const char *weekdays[] =
- {
- "Sunday", "Monday", "Tuesday", "Wednesday",
- "Thursday", "Friday", "Saturday"
- };
- elm_dayselector_wekdays_names_set(calendar, weekdays);
- @endcode
-
- @see elm_dayselector_weekdays_name_get()
- @see elm_dayselector_weekend_start_set()
-
- @since 1.8
-
- @ingroup Dayselector */
+ [[Set weekdays names to be displayed by the Dayselector.
+
+ By default or if weekdays is $null, weekdays abbreviations get from
system are displayed:
+ E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
+
+ The first string should be related to Sunday, the second to
Monday...
+
+ See also @.weekdays_names_get,
+ @.weekend_start.set.
+
+ @since 1.8
+ ]]
+ /* FIXME-doc
+ *
+ * The usage should be like this:
+ * @code
+ * const char *weekdays[] =
+ * {
+ * "Sunday", "Monday", "Tuesday", "Wednesday",
+ * "Thursday", "Friday", "Saturday"
+ * };
+ * elm_dayselector_wekdays_names_set(calendar, weekdays);
+ * @endcode
+ */
params {
- @in weekdays: const(char)* * @nullable; /*@ Array of seven strings
to be used as weekday names.
- @warning It must have 7 elements, or it will access invalid memory.
- @warning The strings must be NULL terminated ('@\0'). */
+ @in weekdays: const(char)* * @nullable; [[Array of seven strings
to be used as weekday names.
+ Warning: It must have 7 elements, or it will access invalid memory.
+ Warning: The strings must be NULL terminated ('@\0').]]
}
}
weekdays_names_get @const {
- /*@
- Get weekdays names displayed by the calendar.
-
- @return A list of seven strings to be used as weekday names.
+ [[Get weekdays names displayed by the calendar.
- By default, weekdays abbreviations get from system are displayed:
- E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
- The first string is related to Sunday, the second to Monday...
+ By default, weekdays abbreviations get from system are displayed:
+ E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
+ The first string is related to Sunday, the second to Monday...
- @see elm_dayselector_weekdays_name_set()
+ See also @.weekdays_names_set.
- @since 1.8
-
- @ingroup Dayselector */
- return: own(list<own(Eina_Stringshare *)> *) @warn_unused;
+ @since 1.8
+ ]]
+ return: own(list<own(Eina_Stringshare *)> *) @warn_unused; [[A list
of seven strings to be used as weekday names.]]
}
day_selected_set {
- /*@
- Set the state of given Dayselector_Day.
-
- @see Elm_Dayselector_Day
- @see elm_dayselector_day_selected_get()
-
- @ingroup Dayselector */
+ [[Set the state of given Dayselector_Day.
+ See also @Elm.Dayselector.Day,
+ @.day_selected_get.
+ ]]
params {
- @in day: Elm.Dayselector.Day; /*@ Dayselector_Day that the user
want to set state. */
- @in selected: bool; /*@ state of the day. @c EINA_TRUE is
selected. */
+ @in day: Elm.Dayselector.Day; [[Dayselector_Day that the user want
to set state.]]
+ @in selected: bool; [[state of the day. $true is selected.]]
}
}
day_selected_get @const {
- /*@
- Get the state of given Dayselector_Day.
-
- @return @c EINA_TRUE, if the Day is selected
-
- @see Elm_Dayselector_Day
- @see elm_dayselector_day_selected_set()
+ [[Get the state of given Dayselector_Day.
- @ingroup Dayselector */
+ See also @Elm.Dayselector.Day,
+ @.day_selected_set.
+ ]]
return: bool;
params {
- @in day: Elm.Dayselector.Day; /*@ Dayselector_Day that the user
want to know state. */
+ @in day: Elm.Dayselector.Day; [[Dayselector_Day that the user want
to know state.]]
}
}
}
--
