stefan pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=c5b00c5974c6a1afcac024c3e9c9edf76322f29f
commit c5b00c5974c6a1afcac024c3e9c9edf76322f29f
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date: Mon Apr 18 22:05:22 2016 +0200
ecore_audio: document ecore_audio core class
Merging some property descriptions and some smaller changes.
---
src/lib/ecore_audio/ecore_audio.eo | 61 +++++++++++++++-----------------------
1 file changed, 24 insertions(+), 37 deletions(-)
diff --git a/src/lib/ecore_audio/ecore_audio.eo
b/src/lib/ecore_audio/ecore_audio.eo
index 38cfe02..db3379d 100644
--- a/src/lib/ecore_audio/ecore_audio.eo
+++ b/src/lib/ecore_audio/ecore_audio.eo
@@ -13,86 +13,73 @@ enum Ecore_Audio_Format {
class Ecore_Audio (Eo.Base)
{
+ [[Convenience audio class.]]
+
legacy_prefix: null;
eo_prefix: ecore_audio_obj;
data: Ecore_Audio_Object;
methods {
@property name {
- set {
- [[Set the name of the object
+ [[Name of the object
- @since 1.8
- ]]
+ @since 1.8
+ ]]
+ set {
}
get {
- [[Get the name of the object
-
- @since 1.8
- ]]
}
values {
- name: const(char)*;
+ name: const(char)*; [[Name]]
}
}
@property paused {
- set {
- [[Set the pause state of the object
+ [[Pause state of the object
- @since 1.8
- ]]
+ @since 1.8
+ ]]
+ set {
}
get {
- [[Get the pause state of the object
-
- @since 1.8
- ]]
}
values {
paused: bool; [[true if object is paused, false if not]]
}
}
@property volume {
- set {
- [[Set the volume of the object
+ [[Volume of the object
- @since 1.8
- ]]
+ @since 1.8
+ ]]
+ set {
}
get {
- [[Get the volume of the object
-
- @since 1.8
- ]]
}
values {
- volume: double; [[the volume]]
+ volume: double; [[The volume]]
}
}
@property source {
- set {
- [[Set the source of the object
+ [[Source of the object
- What sources are supported depends on the actual object.
- For example, the libsndfile class accepts WAV, OGG, FLAC
- files as source.
+ What sources are supported depends on the actual object.
+ For example, the libsndfile class accepts WAV, OGG, FLAC
+ files as source.
- @since 1.8
- ]]
+ @since 1.8
+ ]]
+ set {
return: bool; [[true if the source was set correctly (i.e. the file
was opened), EINA_FALSE otherwise
]]
}
get {
- [[Get the source of the object
-
- @since 1.8
- ]]
}
values {
source: const(char)*; [[the source to set to (i.e. file, URL,
device)]]
}
}
@property format {
+ [[Format of the object.]]
set {
[[Set the format of the object
--
