summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_gfx_color.eo
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-13 12:25:49 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-13 12:30:03 +0200
commit8c09c1cae8b4368b88ec0b296f124d35e735dc7e (patch)
tree16548e1c5e3c8ac8b51398525da011ab555d4e29 /src/lib/efl/interfaces/efl_gfx_color.eo
parent5e9b30153399014ff0aa52922f8460c7769eb741 (diff)
docs: Move property docs to property level instead of set/get
Eolian @properties should be documented at the property level, and documentation at the setter or getter level should be left to setter- or getter-specific comments. There is usually no need at all to have setter- or getter- specific comments. Also, a property is not a method so descriptions should match that. This patch removes lots of duplicated text, and will allow enabling by default the eolian check that ensures that properties have proper property-level docs. No functional changes.
Diffstat (limited to 'src/lib/efl/interfaces/efl_gfx_color.eo')
-rw-r--r--src/lib/efl/interfaces/efl_gfx_color.eo51
1 files changed, 20 insertions, 31 deletions
diff --git a/src/lib/efl/interfaces/efl_gfx_color.eo b/src/lib/efl/interfaces/efl_gfx_color.eo
index fa0d1d4c37..e507440ace 100644
--- a/src/lib/efl/interfaces/efl_gfx_color.eo
+++ b/src/lib/efl/interfaces/efl_gfx_color.eo
@@ -9,35 +9,28 @@ mixin Efl.Gfx.Color
9 data: null; 9 data: null;
10 methods { 10 methods {
11 @property color @pure_virtual { 11 @property color @pure_virtual {
12 set { 12 [[The general/main color of the given Evas object.
13 [[Sets the general/main color of the given Evas object to the given
14 one.
15
16 See also @.color.get (for an example)
17
18 These color values are expected to be premultiplied by alpha.
19 ]]
20 }
21 get {
22 [[Retrieves the general/main color of the given Evas object.
23 13
24 Retrieves the main color's RGB component (and alpha channel) 14 Represents the main color's RGB component (and alpha channel)
25 values, which range from 0 to 255. For the alpha channel, 15 values, which range from 0 to 255. For the alpha channel,
26 which defines the object's transparency level, 0 means totally 16 which defines the object's transparency level, 0 means totally
27 transparent, while 255 means opaque. These color values are 17 transparent, while 255 means opaque. These color values are
28 premultiplied by the alpha value. 18 premultiplied by the alpha value.
29 19
30 Usually youll use this attribute for text and rectangle objects, 20 Usually you'll use this attribute for text and rectangle objects,
31 where the main color is their unique one. If set for objects 21 where the main color is the only color. If set for objects
32 which themselves have colors, like the images one, those colors 22 which themselves have colors, like the images one, those colors
33 get modulated by this one. 23 get modulated by this one.
34 24
35 All newly created Evas rectangles get the default color 25 All newly created Evas rectangles get the default color
36 values of 255 255 255 255 (opaque white). 26 values of 255 255 255 255 (opaque white).
37 27
38 Use null pointers on the components you're not interested 28 When reading this property, use $NULL pointers on the components you're not interested
39 in: they'll be ignored by the function. 29 in and they'll be ignored by the function.
40 ]] 30 ]]
31 set {
32 }
33 get {
41 } 34 }
42 values { 35 values {
43 r: int; 36 r: int;
@@ -47,15 +40,11 @@ mixin Efl.Gfx.Color
47 } 40 }
48 } 41 }
49 @property color_code { 42 @property color_code {
43 [[Hexadecimal color code of given Evas object (#RRGGBBAA).
44 ]]
50 set { 45 set {
51 [[Set the color of given Evas object to the given hex color code(#RRGGBBAA).
52 e.g. efl_gfx_color_code_set(obj, "#FFCCAACC");
53 ]]
54 } 46 }
55 get { 47 get {
56 [[Get hex color code of given Evas object.
57 This returns a short lived hex color code string.
58 ]]
59 } 48 }
60 values { 49 values {
61 colorcode: string; [[the hex color code.]] 50 colorcode: string; [[the hex color code.]]