q66 pushed a commit to branch master. http://git.enlightenment.org/core/elementary.git/commit/?id=3f3c0f364d104cbf524859ac2d3ce9115209e0c1
commit 3f3c0f364d104cbf524859ac2d3ce9115209e0c1 Author: Vivek Ellur <[email protected]> Date: Tue Jul 21 15:01:46 2015 +0100 elm_color_item: Convert eo docs to new format Summary: Updated docs for elm_color_item.eo and elm_colorselector.eo files Signed-off-by: Vivek Ellur <[email protected]> Reviewers: q66 Reviewed By: q66 Differential Revision: https://phab.enlightenment.org/D2850 --- src/lib/elm_color_item.eo | 78 +++++++++++++------------------ src/lib/elm_colorselector.eo | 109 +++++++++++++++---------------------------- 2 files changed, 71 insertions(+), 116 deletions(-) diff --git a/src/lib/elm_color_item.eo b/src/lib/elm_color_item.eo index 99320cb..b918c49 100644 --- a/src/lib/elm_color_item.eo +++ b/src/lib/elm_color_item.eo @@ -2,54 +2,42 @@ class Elm.Color_Item(Elm.Widget_Item) { eo_prefix: elm_obj_color_item; methods { - @property color { - get { - /*@ - Get Palette item's color. + @property color { + get { + [[Get Palette item's color.]] + } + set { + [[Set Palette item's color.]] + } + values { + r: int; [[red-value of color]] + g: int; [[green-value of color]] + b: int; [[blue-value of color]] + a: int; [[alpha-value of color]] + } + } + @property selected { + get { + [[Get the selected state of color palette item - @ingroup Colorselector - */ - } - set { - /*@ - Set Palette item's color. + @since 1.9 + ]] + } + set { + [[Set the selected state of color palette item - @ingroup Colorselector - */ - } - values { - r: int; /*@ red-value of color */ - g: int; /*@ green-value of color */ - b: int; /*@ blue-value of color */ - a: int; /*@ alpha-value of color */ - } - } - @property selected { - get { - /*@ - Get the selected state of color palette item - - @since 1.9 - @ingroup Colorselector - */ - } - set { - /*@ - Set the selected state of color palette item - - @since 1.9 - @ingroup Colorselector - */ - } - values { - selected: bool; /*@ @c EINA_TRUE if selected @c EINA_FALSE otherwise */ - } - } + @since 1.9 + ]] + } + values { + selected: bool; [[$true if selected $false otherwise]] + } + } } implements { - Eo.Base.constructor; - Eo.Base.destructor; - Elm.Widget_Item.access_register; - Elm.Widget_Item.signal_emit; + Eo.Base.constructor; + Eo.Base.destructor; + Elm.Widget_Item.access_register; + Elm.Widget_Item.signal_emit; } } diff --git a/src/lib/elm_colorselector.eo b/src/lib/elm_colorselector.eo index fee1c23..cc036c7 100644 --- a/src/lib/elm_colorselector.eo +++ b/src/lib/elm_colorselector.eo @@ -19,121 +19,88 @@ class Elm.Colorselector (Elm.Layout, Elm_Interface_Atspi_Widget_Action, methods { @property color { set { - /*@ - Set color to colorselector + [[Set color to colorselector.]] - @ingroup Colorselector */ } get { - /*@ - Get current color from colorselector - - @ingroup Colorselector */ + [[Get current color from colorselector.]] } values { - r: int; /*@ r-value of color */ - g: int; /*@ g-value of color */ - b: int; /*@ b-value of color */ - a: int; /*@ a-value of color */ + r: int; [[r-value of color]] + g: int; [[g-value of color]] + b: int; [[b-value of color]] + a: int; [[a-value of color]] } } @property palette_name { set { - /*@ - Set current palette's name - - When colorpalette name is set, colors will be loaded from and saved to config - using the set name. If no name is set then colors will be loaded from or - saved to "default" config. + [[Set current palette's name - @ingroup Colorselector */ + When colorpalette name is set, colors will be loaded from and saved to config + using the set name. If no name is set then colors will be loaded from or + saved to "default" config. + ]] } get { - /*@ - Get current palette's name - - @return Name of palette - - Returns the currently set palette name using which colors will be - saved/loaded in to config. + [[Get current palette's name - @ingroup Colorselector */ + Returns the currently set palette name using which colors will be + saved/loaded in to config. + ]] } values { - palette_name: const(char)*; /*@ Name of palette */ + palette_name: const(char)*; [[Name of palette]] } } @property mode { set { - /*@ - Set Colorselector's mode. + [[Set Colorselector's mode. - Colorselector supports three modes palette only, selector only and both. - - @ingroup Colorselector */ + Colorselector supports three modes palette only, selector only and both. + ]] } get { - /*@ - Get Colorselector's mode. - - @return mode The current mode of colorselector - - @ingroup Colorselector */ + [[Get Colorselector's mode.]] } values { - mode: Elm.Colorselector.Mode; /*@ Elm_Colorselector_Mode */ + mode: Elm.Colorselector.Mode; [[Elm_Colorselector_Mode]] } } @property palette_items { get { - /*@ - Get list of palette items. + [[Get list of palette items. - @return The list of color palette items. + Note That palette item list is internally managed by colorselector widget and + it should not be freed/modified by application. - Note That palette item list is internally managed by colorselector widget and - it should not be freed/modified by application. - - @since 1.9 - - @ingroup Colorselector */ - return: const(list<Elm.Object.Item*>)*; + @since 1.9 + ]] + return: const(list<Elm.Object.Item*>)*;[[The list of color palette items.]] } } @property palette_selected_item { get { - /*@ - Get the selected item in colorselector palette. + [[Get the selected item in colorselector palette. - @return The selected item, or NULL if none is selected. + @since 1.9]] - @since 1.9 - @ingroup Colorselector */ - return: Elm_Object_Item *; + return: Elm_Object_Item *;[[The selected item, or $null if none +selected.]] } } palette_color_add { - /*@ - Add a new color item to palette. - - @return A new color palette Item. + [[Add a new color item to palette.]] - @ingroup Colorselector */ - - return: Elm_Object_Item *; + return: Elm_Object_Item *;[[A new color palette Item.]] params { - @in r: int; /*@ r-value of color */ - @in g: int; /*@ g-value of color */ - @in b: int; /*@ b-value of color */ - @in a: int; /*@ a-value of color */ + @in r: int; [[r-value of color]] + @in g: int; [[g-value of color]] + @in b: int; [[b-value of color]] + @in a: int; [[a-value of color]] } } palette_clear { - /*@ - Clear the palette items. - - @ingroup Colorselector */ - + [[Clear the palette items.]] } } implements { --
