diff options
author | Daniel Kolesa <d.kolesa@osg.samsung.com> | 2015-06-10 14:34:54 +0100 |
---|---|---|
committer | Daniel Kolesa <d.kolesa@osg.samsung.com> | 2015-06-10 14:35:11 +0100 |
commit | 7d40ec0ad96b1621c95d3424355f6435d4c39c2e (patch) | |
tree | bbdba67ec604c41cf69a32f2774181c9d52dc29b | |
parent | f1519f3334eabced1d29202ce6fa7f95de4d9525 (diff) |
ector,ecore,eio,emotion: convert some docs
-rw-r--r-- | src/lib/ecore/ecore_idle_exiter.eo | 2 | ||||
-rw-r--r-- | src/lib/ector/ector_generic_surface.eo | 10 | ||||
-rw-r--r-- | src/lib/ector/ector_renderer_generic_base.eo | 46 | ||||
-rw-r--r-- | src/lib/eio/eio_model.eo | 40 | ||||
-rw-r--r-- | src/lib/emotion/emotion_object.eo | 69 |
5 files changed, 80 insertions, 87 deletions
diff --git a/src/lib/ecore/ecore_idle_exiter.eo b/src/lib/ecore/ecore_idle_exiter.eo index 6e52f627b3..8e79177630 100644 --- a/src/lib/ecore/ecore_idle_exiter.eo +++ b/src/lib/ecore/ecore_idle_exiter.eo | |||
@@ -3,7 +3,7 @@ class Ecore.Idle.Exiter (Eo.Base) | |||
3 | eo_prefix: ecore_idle_exiter; | 3 | eo_prefix: ecore_idle_exiter; |
4 | methods { | 4 | methods { |
5 | constructor { | 5 | constructor { |
6 | /*@ Constructor. */ | 6 | [[Constructor.]] |
7 | legacy: null; | 7 | legacy: null; |
8 | params { | 8 | params { |
9 | @in func: Ecore_Task_Cb; | 9 | @in func: Ecore_Task_Cb; |
diff --git a/src/lib/ector/ector_generic_surface.eo b/src/lib/ector/ector_generic_surface.eo index e8540fbf0a..a391ea08a2 100644 --- a/src/lib/ector/ector_generic_surface.eo +++ b/src/lib/ector/ector_generic_surface.eo | |||
@@ -4,19 +4,19 @@ abstract Ector.Generic.Surface (Eo.Base) | |||
4 | methods { | 4 | methods { |
5 | @property size { | 5 | @property size { |
6 | set { | 6 | set { |
7 | /*@ Changes the size of the given Evas object. */ | 7 | [[Changes the size of the given Evas object.]] |
8 | } | 8 | } |
9 | get { | 9 | get { |
10 | /*@ Retrieves the (rectangular) size of the given Evas object. */ | 10 | [[Retrieves the (rectangular) size of the given Evas object.]] |
11 | } | 11 | } |
12 | values { | 12 | values { |
13 | w: int; /*@ in */ | 13 | w: int; |
14 | h: int; /*@ in */ | 14 | h: int; |
15 | } | 15 | } |
16 | } | 16 | } |
17 | @property reference_point { | 17 | @property reference_point { |
18 | set { | 18 | set { |
19 | /*@ This define where is (0,0) in pixels coordinate inside the surface */ | 19 | [[This define where is (0,0) in pixels coordinate inside the surface]] |
20 | } | 20 | } |
21 | values { | 21 | values { |
22 | x: int; | 22 | x: int; |
diff --git a/src/lib/ector/ector_renderer_generic_base.eo b/src/lib/ector/ector_renderer_generic_base.eo index 3e82ed3773..2a490f28c7 100644 --- a/src/lib/ector/ector_renderer_generic_base.eo +++ b/src/lib/ector/ector_renderer_generic_base.eo | |||
@@ -24,45 +24,41 @@ abstract Ector.Renderer.Generic.Base (Eo.Base) | |||
24 | } | 24 | } |
25 | @property visibility { | 25 | @property visibility { |
26 | set { | 26 | set { |
27 | /*@ Makes the given Ector renderer visible or invisible. */ | 27 | [[Makes the given Ector renderer visible or invisible.]] |
28 | } | 28 | } |
29 | get { | 29 | get { |
30 | /*@ Retrieves whether or not the given Ector renderer is visible. */ | 30 | [[Retrieves whether or not the given Ector renderer is visible.]] |
31 | } | 31 | } |
32 | values { | 32 | values { |
33 | v: bool; /*@ @c EINA_TRUE if to make the object visible, @c EINA_FALSE otherwise */ | 33 | v: bool; [[true if to make the object visible, false otherwise]] |
34 | } | 34 | } |
35 | } | 35 | } |
36 | @property color { | 36 | @property color { |
37 | set { | 37 | set { |
38 | /*@ | 38 | [[Sets the general/main color of the given Ector renderer to the |
39 | Sets the general/main color of the given Ector renderer to the given | 39 | given one. |
40 | one. | ||
41 | 40 | ||
42 | @note These color values are expected to be premultiplied by @p a. | 41 | These color values are expected to be premultiplied by alpha. |
43 | 42 | ]] | |
44 | @ingroup Ector_Renderer_Group_Basic */ | ||
45 | } | 43 | } |
46 | get { | 44 | get { |
47 | /*@ | 45 | [[Retrieves the general/main color of the given Ector renderer. |
48 | Retrieves the general/main color of the given Ector renderer. | ||
49 | |||
50 | Retrieves the main color's RGB component (and alpha channel) | ||
51 | values, <b>which range from 0 to 255</b>. For the alpha channel, | ||
52 | which defines the object's transparency level, 0 means totally | ||
53 | transparent, while 255 means opaque. These color values are | ||
54 | premultiplied by the alpha value. | ||
55 | 46 | ||
56 | @note Use @c NULL pointers on the components you're not interested | 47 | Retrieves the main color's RGB component (and alpha channel) |
57 | in: they'll be ignored by the function. | 48 | values, which range from 0 to 255. For the alpha channel, |
49 | which defines the object's transparency level, 0 means totally | ||
50 | transparent, while 255 means opaque. These color values are | ||
51 | premultiplied by the alpha value. | ||
58 | 52 | ||
59 | @ingroup Ector_Renderer_Group_Basic */ | 53 | Use null pointers on the components you're not interested in, |
54 | they'll be ignored by the function. | ||
55 | ]] | ||
60 | } | 56 | } |
61 | values { | 57 | values { |
62 | r: int; /*@ The red component of the given color. */ | 58 | r: int; [[The red component of the given color.]] |
63 | g: int; /*@ The green component of the given color. */ | 59 | g: int; [[The green component of the given color.]] |
64 | b: int; /*@ The blue component of the given color. */ | 60 | b: int; [[The blue component of the given color.]] |
65 | a: int; /*@ The alpha component of the given color. */ | 61 | a: int; [[The alpha component of the given color.]] |
66 | } | 62 | } |
67 | } | 63 | } |
68 | @property mask { | 64 | @property mask { |
@@ -92,7 +88,7 @@ abstract Ector.Renderer.Generic.Base (Eo.Base) | |||
92 | return: bool @warn_unused; | 88 | return: bool @warn_unused; |
93 | params { | 89 | params { |
94 | @in op: Ector_Rop; | 90 | @in op: Ector_Rop; |
95 | @in clips: array<Eina_Rectangle *> *; /*@ array of Eina_Rectangle clip */ | 91 | @in clips: array<Eina_Rectangle *> *; [[array of Eina_Rectangle clip]] |
96 | @in mul_col: uint; | 92 | @in mul_col: uint; |
97 | } | 93 | } |
98 | } | 94 | } |
diff --git a/src/lib/eio/eio_model.eo b/src/lib/eio/eio_model.eo index a32c48a350..d3789168c9 100644 --- a/src/lib/eio/eio_model.eo +++ b/src/lib/eio/eio_model.eo | |||
@@ -3,30 +3,30 @@ class Eio.Model (Eo.Base, Efl.Model.Base) | |||
3 | legacy_prefix: null; | 3 | legacy_prefix: null; |
4 | methods { | 4 | methods { |
5 | children_filter_set { | 5 | children_filter_set { |
6 | /*@ Set children filter callback. | 6 | [[Set children filter callback. |
7 | This function sets, along with user's private data userdata, | 7 | |
8 | the Eio's Eio_Filter_Direct_Cb which is a mid-step | 8 | This function sets, along with user's private data userdata, |
9 | before receiving the real data. Once in filter | 9 | the Eio's Eio_Filter_Direct_Cb which is a mid-step before |
10 | callback we can decide, by returning either EINA_FALSE, to abort | 10 | receiving the real data. Once in filter callback we can decide, |
11 | the notification or EINA_TRUE to keep it. | 11 | by returning either EINA_FALSE, to abort the notification or |
12 | @see Eio.h | 12 | EINA_TRUE to keep it. |
13 | @see emodel_children_slice_fetch | 13 | |
14 | @def emodel_children_filter_set | 14 | See also @emodel_children_slice_fetch, @emodel_children_filter_set. |
15 | @since 1.11 | 15 | |
16 | @in filter_cb | 16 | @since 1.11 |
17 | @in userdata */ | 17 | ]] |
18 | params { | 18 | params { |
19 | filter_cb: Eio_Filter_Direct_Cb; /*@ Filter callback */ | 19 | filter_cb: Eio_Filter_Direct_Cb; [[Filter callback]] |
20 | userdata: void *; /*@ User's private data */ | 20 | userdata: void *; [[User's private data]] |
21 | } | 21 | } |
22 | } | 22 | } |
23 | path_set { | 23 | path_set { |
24 | /*@ Custom Eio_Model constructor. | 24 | [[Custom Eio_Model constructor. |
25 | @def eio_model_constructor | 25 | |
26 | @since 1.11 | 26 | @since 1.11 |
27 | @in path */ | 27 | ]] |
28 | params { | 28 | params { |
29 | @in path: const(char)*; /*@ Root path provided by caller */ | 29 | @in path: const(char)*; [[Root path provided by caller]] |
30 | } | 30 | } |
31 | } | 31 | } |
32 | } | 32 | } |
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 | } |