kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: ecore_adio: finish up eo docs for ecore_audio

This commit is contained in:
Stefan Schmidt 2016-11-11 09:26:22 +01:00
parent 124effc524
commit acba97cd04
3 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/lib/ecore_audio/ecore_audio.eo
View File

@ -42,7 +42,7 @@ class Ecore.Audio (Efl.Object)
get {
}
values {
paused: bool; [[true if object is paused, false if not]]
paused: bool; [[$true if object is paused, $false otherwise]]
}
}
@property volume {
@ -68,14 +68,13 @@ class Ecore.Audio (Efl.Object)
@since 1.8
]]
set {
return: bool; [[true if the source was set correctly (i.e. the file
was opened), EINA_FALSE otherwise
]]
return: bool; [[$true if the source was set correctly (i.e. the file
was opened), $false otherwise]]
}
get {
}
values {
source: string; [[the source to set to (i.e. file, URL, device)]]
source: string; [[The source to set to (i.e. file, URL, device)]]
}
}
@property format @virtual_pure {
@ -88,7 +87,7 @@ class Ecore.Audio (Efl.Object)
@since 1.8
]]
return: bool; [[true if the format was supported, false otherwise]]
return: bool; [[$true if the format was supported, $false otherwise]]
}
get {
[[Get the format of the object
@ -100,7 +99,7 @@ class Ecore.Audio (Efl.Object)
]]
}
values {
format: Ecore.Audio.Format; [[the format of the object]]
format: Ecore.Audio.Format; [[The audio format of the object]]
}
}
vio_set @virtual_pure {
@ -109,11 +108,11 @@ class Ecore.Audio (Efl.Object)
@since 1.8
]]
params {
vio: ptr(Ecore.Audio.Vio); [[the @Ecore.Audio.Vio struct with
vio: ptr(Ecore.Audio.Vio); [[The @Ecore.Audio.Vio struct with
the function callbacks
]]
data: void_ptr; [[user data to pass to the VIO functions]]
free_func: efl_key_data_free_func; [[this function takes care to
data: void_ptr; [[User data to pass to the VIO functions]]
free_func: efl_key_data_free_func; [[This function takes care to
clean up $data when he VIO is
destroyed. NULL means do
nothing.

4
src/lib/ecore_audio/ecore_audio_in.eo
View File

@ -54,7 +54,7 @@ class Ecore.Audio.In (Ecore.Audio)
get {
}
values {
preloaded: bool; [[true if the input should be cached, false otherwise]]
preloaded: bool; [[$true if the input should be cached, false $otherwise]]
}
}
@property looped {
@ -71,7 +71,7 @@ class Ecore.Audio.In (Ecore.Audio)
get {
}
values {
looped: bool; [[true if the input should be looped, false otherwise]]
looped: bool; [[$true if the input should be looped, $false otherwise]]
}
}
@property length {

4
src/lib/ecore_audio/ecore_audio_out.eo
View File

@ -10,7 +10,7 @@ class Ecore.Audio.Out (Ecore.Audio)
@since 1.8
]]
return: bool; [[true if the input was attached, false otherwise]]
return: bool; [[$true if the input was attached, $false otherwise]]
params {
@in input: Ecore.Audio.In; [[The input to attach to the output]]
}
@ -20,7 +20,7 @@ class Ecore.Audio.Out (Ecore.Audio)
@since 1.8
]]
return: bool; [[true if the input was detached, false otherwise]]
return: bool; [[$true if the input was detached, $false otherwise]]
params {
@in input: Ecore.Audio.In; [[The input to detach to the output]]
}