summaryrefslogtreecommitdiff
path: root/src/lib/elementary
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-10-07 16:40:50 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-10-07 16:40:50 +0200
commit5a447ed3273b6b80d9e48aea3cddfcafa1cb8c33 (patch)
tree9ac87445b02f7ee7d54801871e325ecef8ee3d08 /src/lib/elementary
parent5cc9ea90c4a0381990e9fd961a99b74d0ce4fade (diff)
docs: Remove redundant documentation
Lots of EO files had the same information at the property and set/get level. Removed the redundant bits, and moved to the property level the common ones. Set and Get documentation should be used only to clarify setter-only or getter-only behavior.
Diffstat (limited to 'src/lib/elementary')
-rw-r--r--src/lib/elementary/efl_access_text.eo3
-rw-r--r--src/lib/elementary/efl_access_value.eo3
-rw-r--r--src/lib/elementary/efl_ui_calendar.eo42
-rw-r--r--src/lib/elementary/efl_ui_internal_text_scroller.eo4
-rw-r--r--src/lib/elementary/efl_ui_theme.eo1
-rw-r--r--src/lib/elementary/efl_ui_view_model.eo2
-rw-r--r--src/lib/elementary/efl_ui_widget.eo34
-rw-r--r--src/lib/elementary/efl_ui_win.eo21
8 files changed, 31 insertions, 79 deletions
diff --git a/src/lib/elementary/efl_access_text.eo b/src/lib/elementary/efl_access_text.eo
index 02a7e16..0fe97c4 100644
--- a/src/lib/elementary/efl_access_text.eo
+++ b/src/lib/elementary/efl_access_text.eo
@@ -88,9 +88,8 @@ interface @beta Efl.Access.Text
88 } 88 }
89 } 89 }
90 @property caret_offset @protected @beta { 90 @property caret_offset @protected @beta {
91 [[Caret offset property]] 91 [[Offset position of the caret (cursor).]]
92 get { 92 get {
93 [[Gets offset position of caret (cursor)]]
94 } 93 }
95 set { 94 set {
96 return: bool; [[$true if caret was successfully moved, $false otherwise.]] 95 return: bool; [[$true if caret was successfully moved, $false otherwise.]]
diff --git a/src/lib/elementary/efl_access_value.eo b/src/lib/elementary/efl_access_value.eo
index c2b8107..8f94b79 100644
--- a/src/lib/elementary/efl_access_value.eo
+++ b/src/lib/elementary/efl_access_value.eo
@@ -3,9 +3,8 @@ interface @beta Efl.Access.Value
3 [[Elementary Access value interface]] 3 [[Elementary Access value interface]]
4 methods { 4 methods {
5 @property value_and_text @protected @beta { 5 @property value_and_text @protected @beta {
6 [[Value and text property]] 6 [[Value and text displayed bye accessible widget.]]
7 get { 7 get {
8 [[Gets value displayed by a accessible widget.]]
9 } 8 }
10 set { 9 set {
11 return: bool; [[$true if setting widgets value has succeeded, otherwise $false .]] 10 return: bool; [[$true if setting widgets value has succeeded, otherwise $false .]]
diff --git a/src/lib/elementary/efl_ui_calendar.eo b/src/lib/elementary/efl_ui_calendar.eo
index 1d522f6..8f9d9db 100644
--- a/src/lib/elementary/efl_ui_calendar.eo
+++ b/src/lib/elementary/efl_ui_calendar.eo
@@ -29,7 +29,7 @@ class @beta Efl.Ui.Calendar extends Efl.Ui.Layout_Base
29 @property first_day_of_week { 29 @property first_day_of_week {
30 [[The first day of week to use on calendar widgets. 30 [[The first day of week to use on calendar widgets.
31 31
32 This is the day that will appear in the left-most column (eg. Monday 32 This is the day that will appear in the left-most column (e.g. Monday
33 in France or Sunday in the US). 33 in France or Sunday in the US).
34 ]] 34 ]]
35 values { 35 values {
@@ -40,19 +40,15 @@ class @beta Efl.Ui.Calendar extends Efl.Ui.Layout_Base
40 @property date_min { 40 @property date_min {
41 [[Minimum date on calendar.]] 41 [[Minimum date on calendar.]]
42 set { 42 set {
43 [[Set the minimum date on calendar. 43 [[Setting the minimum date changes the displayed month or year if needed.
44 44 Displayed days may also be disabled if they are smaller than minimum date.
45 Set the minimum date, changing the displayed month or year if needed. 45 If the minimum date is greater than @.date_max date, the minimum
46 Displayed day also to be disabled if it is smaller than minimum date. 46 date will be changed to the maximum date returning $false.
47 If the minimum date is greater than current maximum date, the minimum
48 date would be changed to the maximum date with returning $false.
49 ]] 47 ]]
50 return: bool; [[$true, on success, $false otherwise]] 48 return: bool; [[$true on success.]]
51 } 49 }
52 get { 50 get {
53 [[Get the minimum date. 51 [[Default value is 1 JAN,1902.
54
55 Default value is 1 JAN,1902.
56 ]] 52 ]]
57 } 53 }
58 values { 54 values {
@@ -62,19 +58,15 @@ class @beta Efl.Ui.Calendar extends Efl.Ui.Layout_Base
62 @property date_max { 58 @property date_max {
63 [[Maximum date on calendar.]] 59 [[Maximum date on calendar.]]
64 set { 60 set {
65 [[Set the maximum date on calendar. 61 [[Setting the maximum date changes the displayed month or year if needed.
66 62 Displayed days may also be disabled if they are bigger than maximum date.
67 Set the maximum date, changing the displayed month or year if needed. 63 If the maximum date is less than @.date_min, the maximum date
68 Displayed day also to be disabled if it is bigger than maximum date. 64 will be changed to the minimum date returning $false.
69 If the maximum date is less than current minimum date, the maximum date
70 would be changed to the minimum date with returning $false.
71 ]] 65 ]]
72 return: bool; [[$true, on success, $false otherwise]] 66 return: bool; [[$true on success.]]
73 } 67 }
74 get { 68 get {
75 [[Get the maximum date. 69 [[Default maximum year is -1.
76
77 Default maximum year is -1.
78 Default maximum day and month are 31 and DEC. 70 Default maximum day and month are 31 and DEC.
79 71
80 If the maximum year is a negative value, it will be limited depending 72 If the maximum year is a negative value, it will be limited depending
@@ -88,12 +80,10 @@ class @beta Efl.Ui.Calendar extends Efl.Ui.Layout_Base
88 @property date { 80 @property date {
89 [[The selected date on calendar.]] 81 [[The selected date on calendar.]]
90 set { 82 set {
91 [[Set the selected date. If the date is greater than the maximum date, 83 [[Dates will be clamped between @.date_min and @.date_max, returning $false
92 the date would be changed to the maximum date with returning $false. 84 when trying to set out-of-bounds values.
93 In the opposite case with the minimum date,
94 this would give the same result.
95 ]] 85 ]]
96 return: bool; [[$true, on success, $false otherwise]] 86 return: bool; [[$true on success.]]
97 } 87 }
98 get { 88 get {
99 } 89 }
diff --git a/src/lib/elementary/efl_ui_internal_text_scroller.eo b/src/lib/elementary/efl_ui_internal_text_scroller.eo
index a05300d..3108000 100644
--- a/src/lib/elementary/efl_ui_internal_text_scroller.eo
+++ b/src/lib/elementary/efl_ui_internal_text_scroller.eo
@@ -16,9 +16,8 @@ class @beta Efl.Ui.Internal_Text_Scroller extends Efl.Ui.Scroller
16 ]] 16 ]]
17 methods { 17 methods {
18 @property scroller_mode { 18 @property scroller_mode {
19 [[Mode of operation for the scroller]] 19 [[Mode of operation for the scroller, either default (singleline) or multiline.]]
20 set { 20 set {
21 [[Sets mode to either default (singleline) or multiline]]
22 } 21 }
23 values { 22 values {
24 mode: Efl.Ui.Text_Scroller_Mode; 23 mode: Efl.Ui.Text_Scroller_Mode;
@@ -27,7 +26,6 @@ class @beta Efl.Ui.Internal_Text_Scroller extends Efl.Ui.Scroller
27 @property viewport_clip { 26 @property viewport_clip {
28 [[The viewport's clip object]] 27 [[The viewport's clip object]]
29 get { 28 get {
30 [[Gets viewport's clip object]]
31 } 29 }
32 values { 30 values {
33 clip: Efl.Object; 31 clip: Efl.Object;
diff --git a/src/lib/elementary/efl_ui_theme.eo b/src/lib/elementary/efl_ui_theme.eo
index a11381d..9320d0a 100644
--- a/src/lib/elementary/efl_ui_theme.eo
+++ b/src/lib/elementary/efl_ui_theme.eo
@@ -11,7 +11,6 @@ class @beta Efl.Ui.Theme extends Efl.Object
11 is set. 11 is set.
12 ]] 12 ]]
13 get { 13 get {
14 [[Gets the default theme handle.]]
15 } 14 }
16 values { 15 values {
17 theme: Efl.Ui.Theme; [[The default theme handle]] 16 theme: Efl.Ui.Theme; [[The default theme handle]]
diff --git a/src/lib/elementary/efl_ui_view_model.eo b/src/lib/elementary/efl_ui_view_model.eo
index ebc25dd..26e29af 100644
--- a/src/lib/elementary/efl_ui_view_model.eo
+++ b/src/lib/elementary/efl_ui_view_model.eo
@@ -120,10 +120,8 @@ class Efl.Ui.View_Model extends Efl.Composite_Model
120 120
121 This can only be applied at construction time.]] 121 This can only be applied at construction time.]]
122 get { 122 get {
123 [[Get the state of the automatic binding of children object.]]
124 } 123 }
125 set { 124 set {
126 [[Set the state of the automatic binding of children object.]]
127 } 125 }
128 values { 126 values {
129 enable: bool; [[Do you automatically bind children. Default to true.]] 127 enable: bool; [[Do you automatically bind children. Default to true.]]
diff --git a/src/lib/elementary/efl_ui_widget.eo b/src/lib/elementary/efl_ui_widget.eo
index ff6f94f..14375c2 100644
--- a/src/lib/elementary/efl_ui_widget.eo
+++ b/src/lib/elementary/efl_ui_widget.eo
@@ -39,17 +39,13 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
39 If using X cursors, a definition of all the valid cursor names 39 If using X cursors, a definition of all the valid cursor names
40 is listed on Elementary_Cursors.h. If an invalid name is set 40 is listed on Elementary_Cursors.h. If an invalid name is set
41 the default cursor will be used. 41 the default cursor will be used.
42
43 If $cursor is set to $null it will be reset to the default one.
42 ]] 44 ]]
43 set { 45 set {
44 [[Sets or unsets the current cursor.
45
46 If $cursor is $null this function will reset the cursor
47 to the default one.
48 ]]
49 return: bool; [[$true if successful.]] 46 return: bool; [[$true if successful.]]
50 } 47 }
51 get { 48 get {
52 [[Returns the current cursor name.]]
53 } 49 }
54 values { 50 values {
55 cursor: string; [[The cursor name, defined either 51 cursor: string; [[The cursor name, defined either
@@ -64,11 +60,9 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
64 setting its style with this property. 60 setting its style with this property.
65 ]] 61 ]]
66 set { 62 set {
67 [[Sets a style for the current cursor. Call after @.cursor.set.]]
68 return: bool; [[$true if successful.]] 63 return: bool; [[$true if successful.]]
69 } 64 }
70 get { 65 get {
71 [[Returns the current cursor style name.]]
72 } 66 }
73 values { 67 values {
74 style: string; [[A specific style to use, e.g. default, 68 style: string; [[A specific style to use, e.g. default,
@@ -82,11 +76,9 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
82 i.e. from the display manager. 76 i.e. from the display manager.
83 ]] 77 ]]
84 set { 78 set {
85 [[Enables or disables theme cursors.]]
86 return: bool; [[$true if successful.]] 79 return: bool; [[$true if successful.]]
87 } 80 }
88 get { 81 get {
89 [[Returns the current state of theme cursors search.]]
90 } 82 }
91 values { 83 values {
92 allow: bool(true); [[Whether to use theme cursors.]] 84 allow: bool(true); [[Whether to use theme cursors.]]
@@ -100,7 +92,6 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
100 function unless you're implementing a widget. 92 function unless you're implementing a widget.
101 ]] 93 ]]
102 set { 94 set {
103 [[Sets the new resize object for this widget.]]
104 } 95 }
105 values { 96 values {
106 sobj: Efl.Canvas.Object; 97 sobj: Efl.Canvas.Object;
@@ -113,21 +104,17 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
113 Each widget may handle the disabled state differently, but overall 104 Each widget may handle the disabled state differently, but overall
114 disabled widgets shall not respond to any input events. This is 105 disabled widgets shall not respond to any input events. This is
115 $false by default, meaning the widget is enabled. 106 $false by default, meaning the widget is enabled.
107
108 Disabling a widget will disable all its children recursively,
109 but only this widget will be marked as disabled internally.
110
111 This will return $true if any widget in the parent hierarchy
112 is disabled. Re-enabling that parent may in turn change the
113 disabled state of this widget.
116 ]] 114 ]]
117 set { 115 set {
118 [[Enables or disables this widget.
119
120 Disabling a widget will disable all its children recursively,
121 but only this widget will be marked as disabled internally.
122 ]]
123 } 116 }
124 get { 117 get {
125 [[Returns whether the widget is disabled.
126
127 This will return $true if any widget in the parent hierarchy
128 is disabled. Re-enabling that parent may in turn change the
129 disabled state of this widget.
130 ]]
131 } 118 }
132 values { 119 values {
133 disabled: bool(false); [[$true if the widget is disabled.]] 120 disabled: bool(false); [[$true if the widget is disabled.]]
@@ -145,13 +132,11 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
145 at construction time of the object (inside $efl_add in C). 132 at construction time of the object (inside $efl_add in C).
146 ]] 133 ]]
147 set { 134 set {
148 [[Can only be called during construction, before finalize.]]
149 return: Eina.Error; 135 return: Eina.Error;
150 [[Whether the style was successfully applied or not, see 136 [[Whether the style was successfully applied or not, see
151 the Efl.Ui.Theme.Apply_Error subset of @Eina.Error for more information.]] 137 the Efl.Ui.Theme.Apply_Error subset of @Eina.Error for more information.]]
152 } 138 }
153 get { 139 get {
154 [[Returns the current style of a widget.]]
155 } 140 }
156 values { 141 values {
157 style: string; 142 style: string;
@@ -354,7 +339,6 @@ abstract Efl.Ui.Widget extends Efl.Canvas.Group implements Efl.Access.Object,
354 displayed. 339 displayed.
355 ]] 340 ]]
356 get { 341 get {
357 [[This is a read-only property.]]
358 } 342 }
359 values { 343 values {
360 region: Eina.Rect; [[The rectangle area.]] 344 region: Eina.Rect; [[The rectangle area.]]
diff --git a/src/lib/elementary/efl_ui_win.eo b/src/lib/elementary/efl_ui_win.eo
index bec6fdb..bca1b4a 100644
--- a/src/lib/elementary/efl_ui_win.eo
+++ b/src/lib/elementary/efl_ui_win.eo
@@ -418,7 +418,6 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W
418 Note: Once set, it cannot be modified afterwards. 418 Note: Once set, it cannot be modified afterwards.
419 ]] 419 ]]
420 set { 420 set {
421 [[Name can only be set before finalize.]]
422 } 421 }
423 get { 422 get {
424 } 423 }
@@ -435,12 +434,12 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W
435 creation time, before finalize. In C this means inside $efl_add(). 434 creation time, before finalize. In C this means inside $efl_add().
436 435
437 Note: Once set, it cannot be modified afterward. 436 Note: Once set, it cannot be modified afterward.
437
438 If the object is not window object, returns @Efl.Ui.Win_Type.unknown.
438 ]] 439 ]]
439 set { 440 set {
440 [[Type can on be set before finalize.]]
441 } 441 }
442 get { 442 get {
443 [[If the object is not window object, returns $unknown.]]
444 } 443 }
445 values { 444 values {
446 type: Efl.Ui.Win_Type(Efl.Ui.Win_Type.basic); [[Window type]] 445 type: Efl.Ui.Win_Type(Efl.Ui.Win_Type.basic); [[Window type]]
@@ -495,8 +494,6 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W
495 set { 494 set {
496 } 495 }
497 get { 496 get {
498 [[This will return the value of "accel_preference" when the window
499 was created.]]
500 } 497 }
501 } 498 }
502 @property alpha { 499 @property alpha {
@@ -741,20 +738,14 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W
741 } 738 }
742 } 739 }
743 @property focus_highlight_enabled { 740 @property focus_highlight_enabled {
744 [[Whether focus highlight is enabled or not. 741 [[Whether focus highlight is enabled or not on this window, regardless of the global setting.
745 742
746 See also @.focus_highlight_style. 743 See also @.focus_highlight_style.
747 See also @.focus_highlight_animate. 744 See also @.focus_highlight_animate.
748 ]] 745 ]]
749 set { 746 set {
750 [[Set the enabled status for the focus highlight in a window.
751
752 This function will enable or disable the focus highlight,
753 regardless of the global setting for it.
754 ]]
755 } 747 }
756 get { 748 get {
757 [[Get the enabled value of the focus highlight for this window.]]
758 } 749 }
759 values { 750 values {
760 enabled: bool; [[The enabled value for the highlight.]] 751 enabled: bool; [[The enabled value for the highlight.]]
@@ -785,14 +776,8 @@ class Efl.Ui.Win extends Efl.Ui.Widget implements Efl.Canvas.Scene, Efl.Access.W
785 See also @.focus_highlight_enabled. 776 See also @.focus_highlight_enabled.
786 ]] 777 ]]
787 set { 778 set {
788 [[Set the animate status for the focus highlight for this window.
789
790 This function will enable or disable the animation of focus
791 highlight.
792 ]]
793 } 779 }
794 get { 780 get {
795 [[Get the animate value of the focus highlight for this window.]]
796 } 781 }
797 values { 782 values {
798 animate: bool; [[The enabled value for the highlight animation.]] 783 animate: bool; [[The enabled value for the highlight animation.]]