summaryrefslogtreecommitdiff
path: root/src/lib/ecore_audio
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-03-20 19:46:44 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-03-20 20:16:05 +0100
commitbbd4b6e5148727b601954aa3bc2c7f50cf4dfba6 (patch)
tree65356104f72d2cc29a6270ad908839278f0c60a1 /src/lib/ecore_audio
parentc081825bc8e5903e213480f9d0af32322555b3a3 (diff)
docs: Remove obsolete @since tags from EO files
Summary: All legacy @since tags have already moved to the *.legacy.h files. EO files are now devoid of @since tags (except some eldbus still needed for legacy). Upcoming patches will add @since 1.22 to those APIs which come out of beta in this release. APIs marked @beta do not need @since tags. Test Plan: Everything builds, EO docs (like DocFX) have no Since tags. Reviewers: zmike, bu5hm4n, lauromoura, cedric Reviewed By: cedric Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D8430
Diffstat (limited to 'src/lib/ecore_audio')
-rw-r--r--src/lib/ecore_audio/ecore_audio.eo12
-rw-r--r--src/lib/ecore_audio/ecore_audio_in.eo22
-rw-r--r--src/lib/ecore_audio/ecore_audio_out.eo6
3 files changed, 0 insertions, 40 deletions
diff --git a/src/lib/ecore_audio/ecore_audio.eo b/src/lib/ecore_audio/ecore_audio.eo
index af668fb..93409d2 100644
--- a/src/lib/ecore_audio/ecore_audio.eo
+++ b/src/lib/ecore_audio/ecore_audio.eo
@@ -21,8 +21,6 @@ abstract @beta Ecore.Audio extends Efl.Object
21 methods { 21 methods {
22 @property paused { 22 @property paused {
23 [[Pauses state of the object 23 [[Pauses state of the object
24
25 @since 1.8
26 ]] 24 ]]
27 set { 25 set {
28 } 26 }
@@ -34,8 +32,6 @@ abstract @beta Ecore.Audio extends Efl.Object
34 } 32 }
35 @property volume { 33 @property volume {
36 [[Volume of the object 34 [[Volume of the object
37
38 @since 1.8
39 ]] 35 ]]
40 set { 36 set {
41 } 37 }
@@ -51,8 +47,6 @@ abstract @beta Ecore.Audio extends Efl.Object
51 What sources are supported depends on the actual object. 47 What sources are supported depends on the actual object.
52 For example, the libsndfile class accepts WAV, OGG, FLAC 48 For example, the libsndfile class accepts WAV, OGG, FLAC
53 files as source. 49 files as source.
54
55 @since 1.8
56 ]] 50 ]]
57 set { 51 set {
58 return: bool; [[$true if the source was set correctly (i.e. the file 52 return: bool; [[$true if the source was set correctly (i.e. the file
@@ -71,8 +65,6 @@ abstract @beta Ecore.Audio extends Efl.Object
71 65
72 What formats are supported depends on the actual object. Default 66 What formats are supported depends on the actual object. Default
73 is ECORE_AUDIO_FORMAT_AUTO 67 is ECORE_AUDIO_FORMAT_AUTO
74
75 @since 1.8
76 ]] 68 ]]
77 return: bool; [[$true if the format was supported, $false otherwise]] 69 return: bool; [[$true if the format was supported, $false otherwise]]
78 } 70 }
@@ -81,8 +73,6 @@ abstract @beta Ecore.Audio extends Efl.Object
81 73
82 After setting the source if the format was ECORE_AUDIO_FORMAT_AUTO 74 After setting the source if the format was ECORE_AUDIO_FORMAT_AUTO
83 this function will now return the actual format. 75 this function will now return the actual format.
84
85 @since 1.8
86 ]] 76 ]]
87 } 77 }
88 values { 78 values {
@@ -91,8 +81,6 @@ abstract @beta Ecore.Audio extends Efl.Object
91 } 81 }
92 vio_set @pure_virtual { 82 vio_set @pure_virtual {
93 [[Sets the virtual IO functions 83 [[Sets the virtual IO functions
94
95 @since 1.8
96 ]] 84 ]]
97 params { 85 params {
98 vio: ptr(Ecore.Audio.Vio); [[The @Ecore.Audio.Vio struct with 86 vio: ptr(Ecore.Audio.Vio); [[The @Ecore.Audio.Vio struct with
diff --git a/src/lib/ecore_audio/ecore_audio_in.eo b/src/lib/ecore_audio/ecore_audio_in.eo
index 7c8582f..bbee8e1 100644
--- a/src/lib/ecore_audio/ecore_audio_in.eo
+++ b/src/lib/ecore_audio/ecore_audio_in.eo
@@ -7,8 +7,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
7 methods { 7 methods {
8 @property speed { 8 @property speed {
9 [[Playback speed of the input. 9 [[Playback speed of the input.
10
11 @since 1.8
12 ]] 10 ]]
13 set { 11 set {
14 } 12 }
@@ -20,8 +18,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
20 } 18 }
21 @property samplerate { 19 @property samplerate {
22 [[Sample-rate of the input 20 [[Sample-rate of the input
23
24 @since 1.8
25 ]] 21 ]]
26 set { 22 set {
27 } 23 }
@@ -33,8 +29,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
33 } 29 }
34 @property channels { 30 @property channels {
35 [[Amount of channels the input has 31 [[Amount of channels the input has
36
37 @since 1.8
38 ]] 32 ]]
39 set { 33 set {
40 } 34 }
@@ -46,8 +40,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
46 } 40 }
47 @property preloaded { 41 @property preloaded {
48 [[Preloaded state of the input 42 [[Preloaded state of the input
49
50 @since 1.8
51 ]] 43 ]]
52 set { 44 set {
53 } 45 }
@@ -63,8 +55,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
63 If the input is looped and reaches the end it will start from the 55 If the input is looped and reaches the end it will start from the
64 beginning again. At the same time the event 56 beginning again. At the same time the event
65 \@ref ECORE_AUDIO_EV_IN_LOOPED will be emitted 57 \@ref ECORE_AUDIO_EV_IN_LOOPED will be emitted
66
67 @since 1.8
68 ]] 58 ]]
69 set { 59 set {
70 } 60 }
@@ -79,8 +69,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
79 69
80 This function is only implemented by some classes 70 This function is only implemented by some classes
81 (i.e. ECORE_AUDIO_OBJ_IN_TONE_CLASS) 71 (i.e. ECORE_AUDIO_OBJ_IN_TONE_CLASS)
82
83 @since 1.8
84 ]] 72 ]]
85 set { 73 set {
86 } 74 }
@@ -93,8 +81,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
93 @property output { 81 @property output {
94 get { 82 get {
95 [[Gets the output that this input is attached to 83 [[Gets the output that this input is attached to
96
97 @since 1.8
98 ]] 84 ]]
99 } 85 }
100 values { 86 values {
@@ -104,8 +90,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
104 @property remaining { 90 @property remaining {
105 get { 91 get {
106 [[Gets the remaining time of the input 92 [[Gets the remaining time of the input
107
108 @since 1.8
109 ]] 93 ]]
110 } 94 }
111 values { 95 values {
@@ -114,8 +98,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
114 } 98 }
115 read { 99 read {
116 [[Reads from the input 100 [[Reads from the input
117
118 @since 1.8
119 ]] 101 ]]
120 return: ssize; [[The amount of samples written to buf]] 102 return: ssize; [[The amount of samples written to buf]]
121 params { 103 params {
@@ -125,8 +107,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
125 } 107 }
126 read_internal { 108 read_internal {
127 [[Internal read function 109 [[Internal read function
128
129 @since 1.8
130 ]] 110 ]]
131 return: ssize; [[The amount of samples written to buf]] 111 return: ssize; [[The amount of samples written to buf]]
132 params { 112 params {
@@ -136,8 +116,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio
136 } 116 }
137 seek { 117 seek {
138 [[Seeks within the input 118 [[Seeks within the input
139
140 @since 1.8
141 ]] 119 ]]
142 return: double; [[The current absolute position in seconds within 120 return: double; [[The current absolute position in seconds within
143 the input]] 121 the input]]
diff --git a/src/lib/ecore_audio/ecore_audio_out.eo b/src/lib/ecore_audio/ecore_audio_out.eo
index 59821c3..f18dd8d 100644
--- a/src/lib/ecore_audio/ecore_audio_out.eo
+++ b/src/lib/ecore_audio/ecore_audio_out.eo
@@ -7,8 +7,6 @@ abstract @beta Ecore.Audio.Out extends Ecore.Audio
7 methods { 7 methods {
8 input_attach { 8 input_attach {
9 [[Attaches an input to an output 9 [[Attaches an input to an output
10
11 @since 1.8
12 ]] 10 ]]
13 return: bool; [[$true if the input was attached, $false otherwise]] 11 return: bool; [[$true if the input was attached, $false otherwise]]
14 params { 12 params {
@@ -17,8 +15,6 @@ abstract @beta Ecore.Audio.Out extends Ecore.Audio
17 } 15 }
18 input_detach { 16 input_detach {
19 [[Detaches an input from an output 17 [[Detaches an input from an output
20
21 @since 1.8
22 ]] 18 ]]
23 return: bool; [[$true if the input was detached, $false otherwise]] 19 return: bool; [[$true if the input was detached, $false otherwise]]
24 params { 20 params {
@@ -27,8 +23,6 @@ abstract @beta Ecore.Audio.Out extends Ecore.Audio
27 } 23 }
28 inputs_get { 24 inputs_get {
29 [[Returns the list of all attached inputs 25 [[Returns the list of all attached inputs
30
31 @since 1.8
32 ]] 26 ]]
33 return: list<Ecore.Audio.In>; [[A list of the inputs that are attached to the output]] 27 return: list<Ecore.Audio.In>; [[A list of the inputs that are attached to the output]]
34 } 28 }