stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=67147dc331c07abec1119ffd3dae78bd0abaf091
commit 67147dc331c07abec1119ffd3dae78bd0abaf091
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Mon Apr 18 11:46:06 2016 +0200
ecore_audio: document all ecore_audio_in classes
For the properties we really only need to document the property itself and
not
its setter and getter functions.
---
src/lib/ecore_audio/ecore_audio_in.eo | 83 ++++++++++-----------------
src/lib/ecore_audio/ecore_audio_in_sndfile.eo | 1 +
src/lib/ecore_audio/ecore_audio_in_tone.eo | 1 +
3 files changed, 32 insertions(+), 53 deletions(-)
diff --git a/src/lib/ecore_audio/ecore_audio_in.eo
b/src/lib/ecore_audio/ecore_audio_in.eo
index 0d62cda..7b0327a 100644
--- a/src/lib/ecore_audio/ecore_audio_in.eo
+++ b/src/lib/ecore_audio/ecore_audio_in.eo
@@ -1,113 +1,90 @@
class Ecore_Audio_In (Ecore_Audio)
{
+ [[Ecore Audio input object.]]
legacy_prefix: null;
eo_prefix: ecore_audio_obj_in;
data: Ecore_Audio_Input;
methods {
@property speed {
- set {
- [[Set the playback speed of the input.
+ [[Playback speed of the input.
- @since 1.8
- ]]
+ @since 1.8
+ ]]
+ set {
}
get {
- [[Get the playback speed of the input.
-
- @since 1.8
- ]]
}
values {
speed: double; [[The speed, 1.0 is the default]]
}
}
@property samplerate {
- set {
- [[Set the sample-rate of the input
+ [[Sample-rate of the input
- @since 1.8
- ]]
+ @since 1.8
+ ]]
+ set {
}
get {
- [[Get the he sample-rate of the input
-
- @since 1.8
- ]]
}
values {
samplerate: int; [[The samplerate in Hz]]
}
}
@property channels {
- set {
- [[Set the amount of channels the input has
+ [[Amount of channels the input has
- @since 1.8
- ]]
+ @since 1.8
+ ]]
+ set {
}
get {
- [[Get the amount of channels the input has
-
- @since 1.8
- ]]
}
values {
channels: int; [[The number of channels]]
}
}
@property preloaded {
- set {
- [[Set the preloaded state of the input
+ [[Preloaded state of the input
- @since 1.8
- ]]
+ @since 1.8
+ ]]
+ set {
}
get {
- [[Get the the preloaded state of the input
-
- @since 1.8
- ]]
}
values {
preloaded: bool; [[true if the input should be cached, false
otherwise]]
}
}
@property looped {
- set {
- [[Set the looped state of the input
+ [[Looped state of the input
- If the input is looped and reaches the end it will start from the
- beginning again. At the same time the event
- \@ref ECORE_AUDIO_EV_IN_LOOPED will be emitted
+ If the input is looped and reaches the end it will start from the
+ beginning again. At the same time the event
+ \@ref ECORE_AUDIO_EV_IN_LOOPED will be emitted
- @since 1.8
- ]]
+ @since 1.8
+ ]]
+ set {
}
get {
- [[Get the looped state of the input
-
- @since 1.8
- ]]
}
values {
looped: bool; [[true if the input should be looped, false
otherwise]]
}
}
@property length {
- set {
- [[Set the length of the input
+ [[Length of the input
- This function is only implemented by some classes
- (i.e. ECORE_AUDIO_OBJ_IN_TONE_CLASS)
+ This function is only implemented by some classes
+ (i.e. ECORE_AUDIO_OBJ_IN_TONE_CLASS)
- @since 1.8
- ]]
+ @since 1.8
+ ]]
+ set {
}
get {
- [[Get the length of the input
-
- @since 1.8
- ]]
}
values {
length: double; [[The length of the input in seconds]]
diff --git a/src/lib/ecore_audio/ecore_audio_in_sndfile.eo
b/src/lib/ecore_audio/ecore_audio_in_sndfile.eo
index 170b385..4396ec9 100644
--- a/src/lib/ecore_audio/ecore_audio_in_sndfile.eo
+++ b/src/lib/ecore_audio/ecore_audio_in_sndfile.eo
@@ -1,5 +1,6 @@
class Ecore_Audio_In_Sndfile (Ecore_Audio_In)
{
+ [[Ecore Audio sndfile input.]]
eo_prefix: ecore_audio_obj_in_sndfile;
implements {
Eo.Base.destructor;
diff --git a/src/lib/ecore_audio/ecore_audio_in_tone.eo
b/src/lib/ecore_audio/ecore_audio_in_tone.eo
index e0cfebf..afa9c3e 100644
--- a/src/lib/ecore_audio/ecore_audio_in_tone.eo
+++ b/src/lib/ecore_audio/ecore_audio_in_tone.eo
@@ -1,5 +1,6 @@
class Ecore_Audio_In_Tone (Ecore_Audio_In)
{
+ [[Ecore Audio tone input.]]
eo_prefix: ecore_audio_obj_in_tone;
implements {
Eo.Base.constructor;
--
