summaryrefslogtreecommitdiff
path: root/src/lib/elementary/efl_ui_image_zoomable.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/elementary/efl_ui_image_zoomable.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/elementary/efl_ui_image_zoomable.eo')
-rw-r--r--src/lib/elementary/efl_ui_image_zoomable.eo26
1 files changed, 9 insertions, 17 deletions
diff --git a/src/lib/elementary/efl_ui_image_zoomable.eo b/src/lib/elementary/efl_ui_image_zoomable.eo
index 62ae9bc..932c732 100644
--- a/src/lib/elementary/efl_ui_image_zoomable.eo
+++ b/src/lib/elementary/efl_ui_image_zoomable.eo
@@ -10,35 +10,27 @@ class @beta Efl.Ui.Image_Zoomable extends Efl.Ui.Image implements Efl.Ui.Zoom,
10 [[Elementary Image Zoomable class]] 10 [[Elementary Image Zoomable class]]
11 methods { 11 methods {
12 @property gesture_enabled { 12 @property gesture_enabled {
13 set { 13 [[The gesture state for photocam.
14 [[Set the gesture state for photocam.
15 14
16 This sets the gesture state to on or off for photocam. The 15 This sets the gesture state to on or off for photocam. The
17 default is off. This will start multi touch zooming. 16 default is off. This will start multi touch zooming.
18 ]] 17 ]]
18 set {
19 } 19 }
20 get { 20 get {
21 [[Get the gesture state for photocam.
22
23 This gets the current gesture state for the photocam object.
24 ]]
25 } 21 }
26 values { 22 values {
27 gesture: bool; [[The gesture state.]] 23 gesture: bool; [[The gesture state.]]
28 } 24 }
29 } 25 }
30 @property image_region { 26 @property image_region {
31 get { 27 [[The region of the image that is currently shown
32 [[Get the region of the image that is currently shown
33 28
34 See also @.image_region.set. 29 Setting it shows the region of the image without using animation.
35 ]] 30 ]]
31 get {
36 } 32 }
37 set { 33 set {
38 [[Set the viewed region of the image
39
40 This shows the region of the image without using animation.
41 ]]
42 } 34 }
43 values { 35 values {
44 region: Eina.Rect; [[The region in the original image pixels.]] 36 region: Eina.Rect; [[The region in the original image pixels.]]