summaryrefslogtreecommitdiff
path: root/src/lib/emotion
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/emotion
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/emotion')
-rw-r--r--src/lib/emotion/efl_canvas_video.eo40
1 files changed, 20 insertions, 20 deletions
diff --git a/src/lib/emotion/efl_canvas_video.eo b/src/lib/emotion/efl_canvas_video.eo
index 2ee6f6b..8ee9607 100644
--- a/src/lib/emotion/efl_canvas_video.eo
+++ b/src/lib/emotion/efl_canvas_video.eo
@@ -4,15 +4,15 @@ class @beta Efl.Canvas.Video extends Efl.Canvas.Group
4 [[Efl canvas video class]] 4 [[Efl canvas video class]]
5 methods { 5 methods {
6 @property option { 6 @property option {
7 set { 7 [[Sets options for the current module.
8 [[Set the specified option for the current module.
9 8
10 This function allows one to mute the video or audio of the 9 This function allows one to mute the video or audio of the
11 emotion object. 10 emotion object.
12 11
13 Please don't use this function, consider using 12 Please don't use this function, consider using
14 @Efl.Player.mute instead. 13 @Efl.Player.mute instead.
15 ]] 14 ]]
15 set {
16 } 16 }
17 values { 17 values {
18 opt: string; [[The option that is being set. Currently 18 opt: string; [[The option that is being set. Currently
@@ -22,23 +22,23 @@ class @beta Efl.Canvas.Video extends Efl.Canvas.Group
22 } 22 }
23 } 23 }
24 @property engine { 24 @property engine {
25 set { 25 [[Initializes an emotion object with the specified module.
26 [[Initializes an emotion object with the specified module.
27 26
28 This function is required after creating the emotion object, 27 This function is required after creating the emotion object,
29 in order to specify which module will be used with this 28 in order to specify which module will be used with this
30 object. Different objects can use different modules to 29 object. Different objects can use different modules to
31 play a media file. The current supported modules are 30 play a media file. The current supported modules are
32 gstreamer and xine. 31 gstreamer and xine.
33 32
34 To use any of them, you need to make sure that support for 33 To use any of them, you need to make sure that support for
35 them was compiled correctly. 34 them was compiled correctly.
36 35
37 It's possible to disable the build of a module with 36 It's possible to disable the build of a module with
38 --disable-module_name. 37 --disable-module_name.
39 38
40 See also @Efl.File.file. 39 See also @Efl.File.file.
41 ]] 40 ]]
41 set {
42 return: bool; [[$true if the specified module was successfully 42 return: bool; [[$true if the specified module was successfully
43 initialized for this object, $false otherwise.]] 43 initialized for this object, $false otherwise.]]
44 } 44 }