diff options
author | Stefan Schmidt <stefan@osg.samsung.com> | 2016-11-11 09:26:22 +0100 |
---|---|---|
committer | Stefan Schmidt <stefan@osg.samsung.com> | 2016-11-11 09:26:22 +0100 |
commit | acba97cd049ce9f4f21c78eaa935c87a252bf42c (patch) | |
tree | 4db3c6655b84d55421e0f9cec2594e128317120c /src/lib | |
parent | 124effc5244658b05b5df6f6265cb0aa4297a119 (diff) |
docs: ecore_adio: finish up eo docs for ecore_audio
Diffstat (limited to 'src/lib')
-rw-r--r-- | src/lib/ecore_audio/ecore_audio.eo | 19 | ||||
-rw-r--r-- | src/lib/ecore_audio/ecore_audio_in.eo | 4 | ||||
-rw-r--r-- | src/lib/ecore_audio/ecore_audio_out.eo | 4 |
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 a80a4c9..74fd206 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) | |||
42 | get { | 42 | get { |
43 | } | 43 | } |
44 | values { | 44 | values { |
45 | paused: bool; [[true if object is paused, false if not]] | 45 | paused: bool; [[$true if object is paused, $false otherwise]] |
46 | } | 46 | } |
47 | } | 47 | } |
48 | @property volume { | 48 | @property volume { |
@@ -68,14 +68,13 @@ class Ecore.Audio (Efl.Object) | |||
68 | @since 1.8 | 68 | @since 1.8 |
69 | ]] | 69 | ]] |
70 | set { | 70 | set { |
71 | return: bool; [[true if the source was set correctly (i.e. the file | 71 | return: bool; [[$true if the source was set correctly (i.e. the file |
72 | was opened), EINA_FALSE otherwise | 72 | was opened), $false otherwise]] |
73 | ]] | ||
74 | } | 73 | } |
75 | get { | 74 | get { |
76 | } | 75 | } |
77 | values { | 76 | values { |
78 | source: string; [[the source to set to (i.e. file, URL, device)]] | 77 | source: string; [[The source to set to (i.e. file, URL, device)]] |
79 | } | 78 | } |
80 | } | 79 | } |
81 | @property format @virtual_pure { | 80 | @property format @virtual_pure { |
@@ -88,7 +87,7 @@ class Ecore.Audio (Efl.Object) | |||
88 | 87 | ||
89 | @since 1.8 | 88 | @since 1.8 |
90 | ]] | 89 | ]] |
91 | return: bool; [[true if the format was supported, false otherwise]] | 90 | return: bool; [[$true if the format was supported, $false otherwise]] |
92 | } | 91 | } |
93 | get { | 92 | get { |
94 | [[Get the format of the object | 93 | [[Get the format of the object |
@@ -100,7 +99,7 @@ class Ecore.Audio (Efl.Object) | |||
100 | ]] | 99 | ]] |
101 | } | 100 | } |
102 | values { | 101 | values { |
103 | format: Ecore.Audio.Format; [[the format of the object]] | 102 | format: Ecore.Audio.Format; [[The audio format of the object]] |
104 | } | 103 | } |
105 | } | 104 | } |
106 | vio_set @virtual_pure { | 105 | vio_set @virtual_pure { |
@@ -109,11 +108,11 @@ class Ecore.Audio (Efl.Object) | |||
109 | @since 1.8 | 108 | @since 1.8 |
110 | ]] | 109 | ]] |
111 | params { | 110 | params { |
112 | vio: ptr(Ecore.Audio.Vio); [[the @Ecore.Audio.Vio struct with | 111 | vio: ptr(Ecore.Audio.Vio); [[The @Ecore.Audio.Vio struct with |
113 | the function callbacks | 112 | the function callbacks |
114 | ]] | 113 | ]] |
115 | data: void_ptr; [[user data to pass to the VIO functions]] | 114 | data: void_ptr; [[User data to pass to the VIO functions]] |
116 | free_func: efl_key_data_free_func; [[this function takes care to | 115 | free_func: efl_key_data_free_func; [[This function takes care to |
117 | clean up $data when he VIO is | 116 | clean up $data when he VIO is |
118 | destroyed. NULL means do | 117 | destroyed. NULL means do |
119 | nothing. | 118 | nothing. |
diff --git a/src/lib/ecore_audio/ecore_audio_in.eo b/src/lib/ecore_audio/ecore_audio_in.eo index 4c7b439..e288ad7 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) | |||
54 | get { | 54 | get { |
55 | } | 55 | } |
56 | values { | 56 | values { |
57 | preloaded: bool; [[true if the input should be cached, false otherwise]] | 57 | preloaded: bool; [[$true if the input should be cached, false $otherwise]] |
58 | } | 58 | } |
59 | } | 59 | } |
60 | @property looped { | 60 | @property looped { |
@@ -71,7 +71,7 @@ class Ecore.Audio.In (Ecore.Audio) | |||
71 | get { | 71 | get { |
72 | } | 72 | } |
73 | values { | 73 | values { |
74 | looped: bool; [[true if the input should be looped, false otherwise]] | 74 | looped: bool; [[$true if the input should be looped, $false otherwise]] |
75 | } | 75 | } |
76 | } | 76 | } |
77 | @property length { | 77 | @property length { |
diff --git a/src/lib/ecore_audio/ecore_audio_out.eo b/src/lib/ecore_audio/ecore_audio_out.eo index 4192e73..4366607 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) | |||
10 | 10 | ||
11 | @since 1.8 | 11 | @since 1.8 |
12 | ]] | 12 | ]] |
13 | return: bool; [[true if the input was attached, false otherwise]] | 13 | return: bool; [[$true if the input was attached, $false otherwise]] |
14 | params { | 14 | params { |
15 | @in input: Ecore.Audio.In; [[The input to attach to the output]] | 15 | @in input: Ecore.Audio.In; [[The input to attach to the output]] |
16 | } | 16 | } |
@@ -20,7 +20,7 @@ class Ecore.Audio.Out (Ecore.Audio) | |||
20 | 20 | ||
21 | @since 1.8 | 21 | @since 1.8 |
22 | ]] | 22 | ]] |
23 | return: bool; [[true if the input was detached, false otherwise]] | 23 | return: bool; [[$true if the input was detached, $false otherwise]] |
24 | params { | 24 | params { |
25 | @in input: Ecore.Audio.In; [[The input to detach to the output]] | 25 | @in input: Ecore.Audio.In; [[The input to detach to the output]] |
26 | } | 26 | } |