summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Schmidt <stefan@osg.samsung.com>2016-11-11 09:26:22 +0100
committerStefan Schmidt <stefan@osg.samsung.com>2016-11-11 09:26:22 +0100
commitacba97cd049ce9f4f21c78eaa935c87a252bf42c (patch)
tree4db3c6655b84d55421e0f9cec2594e128317120c
parent124effc5244658b05b5df6f6265cb0aa4297a119 (diff)
downloadefl-acba97cd049ce9f4f21c78eaa935c87a252bf42c.tar.gz
docs: ecore_adio: finish up eo docs for ecore_audio
-rw-r--r--src/lib/ecore_audio/ecore_audio.eo19
-rw-r--r--src/lib/ecore_audio/ecore_audio_in.eo4
-rw-r--r--src/lib/ecore_audio/ecore_audio_out.eo4
3 files changed, 13 insertions, 14 deletions
diff --git a/src/lib/ecore_audio/ecore_audio.eo b/src/lib/ecore_audio/ecore_audio.eo
index a80a4c94e9..74fd206434 100644
--- a/src/lib/ecore_audio/ecore_audio.eo
+++ b/src/lib/ecore_audio/ecore_audio.eo
@@ -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.
diff --git a/src/lib/ecore_audio/ecore_audio_in.eo b/src/lib/ecore_audio/ecore_audio_in.eo
index 4c7b439ef1..e288ad7007 100644
--- a/src/lib/ecore_audio/ecore_audio_in.eo
+++ b/src/lib/ecore_audio/ecore_audio_in.eo
@@ -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 {
diff --git a/src/lib/ecore_audio/ecore_audio_out.eo b/src/lib/ecore_audio/ecore_audio_out.eo
index 4192e73ed5..436660721d 100644
--- a/src/lib/ecore_audio/ecore_audio_out.eo
+++ b/src/lib/ecore_audio/ecore_audio_out.eo
@@ -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]]
}