summaryrefslogtreecommitdiff
path: root/src/lib/emotion
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-10 14:34:54 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-06-10 14:35:11 +0100
commit7d40ec0ad96b1621c95d3424355f6435d4c39c2e (patch)
treebbdba67ec604c41cf69a32f2774181c9d52dc29b /src/lib/emotion
parentf1519f3334eabced1d29202ce6fa7f95de4d9525 (diff)
ector,ecore,eio,emotion: convert some docs
Diffstat (limited to 'src/lib/emotion')
-rw-r--r--src/lib/emotion/emotion_object.eo69
1 files changed, 33 insertions, 36 deletions
diff --git a/src/lib/emotion/emotion_object.eo b/src/lib/emotion/emotion_object.eo
index 0e9bff5509..3be80dd881 100644
--- a/src/lib/emotion/emotion_object.eo
+++ b/src/lib/emotion/emotion_object.eo
@@ -3,52 +3,49 @@ class Emotion.Object (Evas.Object_Smart, Efl.File, Efl.Player, Efl.Image) {
3 methods { 3 methods {
4 @property option { 4 @property option {
5 set { 5 set {
6 /*@ 6 [[Set the specified option for the current module.
7 * @brief Set the specified option for the current module. 7
8 * 8 This function allows one to mute the video or audio of the
9 * This function allows one to mute the video or audio of the emotion object. 9 emotion object.
10 * 10
11 * @note Please don't use this function, consider using 11 Please don't use this function, consider using
12 * emotion_object_audio_mute_set() and emotion_object_video_mute_set() instead. 12 @emotion_object_audio_mute_set() and
13 * 13 @emotion_object_video_mute_set instead.
14 * @see emotion_object_audio_mute_set() 14 ]]
15 * @see emotion_object_video_mute_set()
16 *
17 * @ingroup Emotion_Init
18 */
19 legacy: emotion_object_module_option_set; 15 legacy: emotion_object_module_option_set;
20 } 16 }
21 values { 17 values {
22 opt: const(char) *; /*@ The option that is being set. Currently supported optiosn: "video" and "audio". */ 18 opt: const(char) *; [[The option that is being set. Currently
23 val: const(char) *; /*@ The value of the option. Currently only supports "off" (?!?!?!) */ 19 supported options: "video" and "audio".]]
20 val: const(char) *; [[The value of the option. Currently only
21 supports "off" (?!?!?!)]]
24 } 22 }
25 } 23 }
26 @property engine { 24 @property engine {
27 set { 25 set {
28 /*@ 26 [[Initializes an emotion object with the specified module.
29 * @brief Initializes an emotion object with the specified module. 27
30 * 28 This function is required after creating the emotion object,
31 * This function is required after creating the emotion object, in order to 29 in order to specify which module will be used with this
32 * specify which module will be used with this object. Different objects can 30 object. Different objects can use different modules to
33 * use different modules to play a media file. The current supported modules are 31 play a media file. The current supported modules are
34 * @b gstreamer and @b xine. 32 gstreamer and xine.
35 * 33
36 * To use any of them, you need to make sure that support for them was compiled 34 To use any of them, you need to make sure that support for
37 * correctly. 35 them was compiled correctly.
38 * 36
39 * @note It's possible to disable the build of a module with 37 It's possible to disable the build of a module with
40 * --disable-module_name. 38 --disable-module_name.
41 * 39
42 * @see emotion_object_add() 40 See also @emotion_object_add and @emotion_object_file_set.
43 * @see emotion_object_file_set() 41 ]]
44 *
45 * @ingroup Emotion_Init
46 */
47 legacy: emotion_object_init; 42 legacy: emotion_object_init;
48 return: bool; /*@ @c EINA_TRUE if the specified module was successfully initialized for this object, @c EINA_FALSE otherwise. */ 43 return: bool; [[true if the specified module was successfully
44 initialized for this object, false otherwise.]]
49 } 45 }
50 values { 46 values {
51 module_filename: const(char) *; /*@ The name of the module to be used (gstreamer or xine). */ 47 module_filename: const(char) *; [[The name of the module to be
48 used (gstreamer or xine).]]
52 } 49 }
53 } 50 }
54 } 51 }