dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

elm_bg: convert eo docs to new format 

Summary:
Converted docs of elm_bg.eo to new format

Signed-off-by: Vivek Ellur <vivek.ellur@samsung.com>

Reviewers: cedric, q66

Differential Revision: https://phab.enlightenment.org/D2819
This commit is contained in:
Vivek Ellur 2015-07-16 11:21:15 +01:00 committed by Daniel Kolesa
parent ee5e4cf27a
commit a8511b117d
2 changed files with 47 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
legacy/elementary/src/lib/elm_atspi_bridge.eo
View File

@ -4,7 +4,7 @@ class Elm.Atspi_Bridge (Eo.Base)
methods { methods {
@property connected { @property connected {
get { get {
/*@ Indicate if connection with AT-SPI2 bus has been established. */ [[Indicate if connection with AT-SPI2 bus has been established.]]
values { values {
ret: bool; ret: bool;
} }
@ -12,7 +12,7 @@ class Elm.Atspi_Bridge (Eo.Base)
} }
@property root { @property root {
get { get {
/*@ Get root object of accessible object hierarchy */ [[Get root object of accessible object hierarchy]]
values { values {
ret: Eo*; ret: Eo*;
} }

97
legacy/elementary/src/lib/elm_bg.eo
View File

@ -19,95 +19,88 @@ class Elm.Bg (Elm.Layout, Efl.File)
methods { methods {
@property option { @property option {
set { set {
/*@ [[Set the mode of display for a given background widget's image
Set the mode of display for a given background widget's image
This sets how the background widget will display its image. This This sets how the background widget will display its image. This
will only work if the elm_bg_file_set() was previously called with will only work if the @Efl.File.file.set was previously called with
an image file on @a obj. The image can be display tiled, scaled, an image file on $obj. The image can be display tiled, scaled,
centered or stretched. #ELM_BG_OPTION_SCALE by default. centered or stretched. @Elm.Bg.Option.scale by default.
@see elm_bg_option_get() See also @.option.get.
]]
@ingroup Bg */
} }
get { get {
/*@ [[Get the mode of display for a given background widget's image.
Get the mode of display for a given background widget's image
@return The image displaying mode in use for @a obj or #ELM_BG_OPTION_LAST, See also @.option.set for more details
on errors.
@see elm_bg_option_set() for more details ]]
@ingroup Bg */
} }
values { values {
option: Elm.Bg.Option; /*@ The desired background option (see #Elm_Bg_Option) */ option: Elm.Bg.Option; [[The desired background option(See @Elm.Bg.Option)]]
} }
} }
@property color { @property color {
set { set {
/*@ [[Set the color on a given background widget
Set the color on a given background widget
This sets the color used for the background rectangle, in RGB This sets the color used for the background rectangle, in RGB
format. Each color component's range is from 0 to 255. format. Each color component's range is from 0 to 255.
@note You probably only want to use this function if you haven't Note: You probably only want to use this function if you haven't
previously called elm_bg_file_set(), so that you just want a solid previously called @Efl.File.file.set, so that you just want a solid
color background. color background.
@note You can reset the color by setting @p r, @p g, @p b as -1, -1, -1. Note: You can reset the color by setting $r, $g, $b as -1, -1, -1.
@see elm_bg_color_get() See also @.color.get
@ingroup Bg */ ]]
legacy: null; /* legacy doesn't have 'a' param */ legacy: null; /* legacy doesn't have 'a' param */
} }
get { get {
/*@ [[Get the color set on a given background widget
Get the color set on a given background widget
@note Use @c NULL pointers on the file components you're not Note: Use $null pointers on the file components you're not
interested in: they'll be ignored by the function. interested in: they'll be ignored by the function.
@see elm_bg_color_get() for more details See also @.color.get for more details
@ingroup Bg */ ]]
legacy: null; /* legacy doesn't have 'a' param */ legacy: null; /* legacy doesn't have 'a' param */
} }
values { values {
r: int; /*@ The red color component's value */ r: int; [[The red color component's value]]
g: int; /*@ The green color component's value */ g: int; [[The green color component's value]]
b: int; /*@ The blue color component's value */ b: int; [[The blue color component's value]]
a: int; /*@ The blue color component's value */ a: int; [[The blue color component's value]]
} }
} }
@property load_size { @property load_size {
set { set {
/*@ [[Set the size of the pixmap representation of the image set on a
Set the size of the pixmap representation of the image set on a given background widget.
given background widget.
@warning This function just makes sense if an image file was set on Warning: This function just makes sense if an image file was set on
@p obj, with elm_bg_file_set(). $obj, with @Efl.File.file.set
This function sets a new size for pixmap representation of the This function sets a new size for pixmap representation of the
given bg image. It allows for the image to be loaded already in the given bg image. It allows for the image to be loaded already in the
specified size, reducing the memory usage and load time (for specified size, reducing the memory usage and load time (for
example, when loading a big image file with its load size set to a example, when loading a big image file with its load size set to a
smaller size) smaller size)
@note This is just a hint for the underlying system. The real size Note: This is just a hint for the underlying system. The real size
of the pixmap may differ depending on the type of image being of the pixmap may differ depending on the type of image being
loaded, being bigger than requested. loaded, being bigger than requested.
@ingroup Bg */ ]]
} }
values { values {
w: Evas.Coord; /*@ The new width of the image pixmap representation. */ w: Evas.Coord; [[The new width of the image pixmap representation.]]
h: Evas.Coord; /*@ The new height of the image pixmap representation. */ h: Evas.Coord; [[The new height of the image pixmap representation.]]
} }
} }
} }