q66 pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=8c51033d4993cf1715324dcc317bb70426e91f13
commit 8c51033d4993cf1715324dcc317bb70426e91f13
Author: Daniel Kolesa <d.kol...@osg.samsung.com>
Date: Mon May 11 15:16:17 2015 +0100
eolian: fix doc comments across the tree
---
src/lib/ecore_con/ecore_con_base.eo | 4 +--
src/lib/ecore_con/ecore_con_url.eo | 4 +--
src/lib/efl/interfaces/efl_player.eo | 10 +++---
src/lib/emotion/emotion_object.eo | 4 +--
src/lib/eo/eo_base.eo | 10 +++---
src/lib/evas/canvas/evas_3d_mesh.eo | 64 ++++++++++++++++++------------------
6 files changed, 48 insertions(+), 48 deletions(-)
diff --git a/src/lib/ecore_con/ecore_con_base.eo
b/src/lib/ecore_con/ecore_con_base.eo
index ff277b8..20c0a21 100644
--- a/src/lib/ecore_con/ecore_con_base.eo
+++ b/src/lib/ecore_con/ecore_con_base.eo
@@ -4,7 +4,7 @@ abstract Ecore.Con.Base (Eo.Base) {
data: null;
methods {
@property ip {
- /**
+ /*@
* Control the IP address of a server that has been connected to.
*
* The param is a pointer to an internal string that contains the IP
address of
@@ -108,7 +108,7 @@ abstract Ecore.Con.Base (Eo.Base) {
legacy: null;
}
send {
- /**
+ /*@
* Sends the given data to the given server.
*
* This function will send the given data to the server as soon as
the program
diff --git a/src/lib/ecore_con/ecore_con_url.eo
b/src/lib/ecore_con/ecore_con_url.eo
index d5d21aa..3698cbf 100644
--- a/src/lib/ecore_con/ecore_con_url.eo
+++ b/src/lib/ecore_con/ecore_con_url.eo
@@ -2,11 +2,11 @@ class Ecore.Con.Url (Eo.Base) {
eo_prefix: ecore_con_url_obj;
methods {
@property url {
- /**
+ /*@
* Controls the URL to send the request to.
*/
set {
- return: bool (false); /* true on success, false on error. */
+ return: bool (false); /*@ true on success, false on error. */
}
get {
}
diff --git a/src/lib/efl/interfaces/efl_player.eo
b/src/lib/efl/interfaces/efl_player.eo
index 7e2d5a2..fdf4f37 100644
--- a/src/lib/efl/interfaces/efl_player.eo
+++ b/src/lib/efl/interfaces/efl_player.eo
@@ -61,7 +61,7 @@ interface Efl.Player {
}
}
@property play_speed {
- /**
+ /*@
* @brief Control the play speed of the media file.
*
* This function control the speed with which the media file will
be played. 1.0
@@ -77,7 +77,7 @@ interface Efl.Player {
}
}
@property audio_volume {
- /**
+ /*@
* @brief Control the audio volume.
*
* Controls the audio volume of the stream being played. This has
nothing to do with
@@ -94,7 +94,7 @@ interface Efl.Player {
}
}
@property audio_mute {
- /**
+ /*@
* @brief This property controls the audio mute state.
*/
set {
@@ -106,7 +106,7 @@ interface Efl.Player {
}
}
@property length {
- /**
+ /*@
* @brief Get the length of play for the media file.
*
* This function returns the length of the media file in seconds.
@@ -118,7 +118,7 @@ interface Efl.Player {
}
}
@property seekable {
- /**
+ /*@
* @brief Get whether the media file is seekable.
*/
get {
diff --git a/src/lib/emotion/emotion_object.eo
b/src/lib/emotion/emotion_object.eo
index d2a90fa..f5530e7 100644
--- a/src/lib/emotion/emotion_object.eo
+++ b/src/lib/emotion/emotion_object.eo
@@ -3,7 +3,7 @@ class Emotion.Object (Evas.Object_Smart, Efl.File, Efl.Player,
Efl.Image) {
methods {
@property option {
set {
- /**
+ /*@
* @brief Set the specified option for the current module.
*
* This function allows one to mute the video or audio of
the emotion object.
@@ -25,7 +25,7 @@ class Emotion.Object (Evas.Object_Smart, Efl.File,
Efl.Player, Efl.Image) {
}
@property engine {
set {
- /**
+ /*@
* @brief Initializes an emotion object with the specified
module.
*
* This function is required after creating the emotion
object, in order to
diff --git a/src/lib/eo/eo_base.eo b/src/lib/eo/eo_base.eo
index b8c7ac0..048ea75 100644
--- a/src/lib/eo/eo_base.eo
+++ b/src/lib/eo/eo_base.eo
@@ -80,7 +80,7 @@ This function registers the object handle pointed by wref to
obj so when obj is
params {
@in const(char)* key; /*@ the key associated with the data */
}
- return: void *; /* the data for the key */
+ return: void *; /*@ the data for the key */
}
key_data_del {
/*@ Del generic data from object. */
@@ -144,7 +144,7 @@ callbacks of the same priority are called in reverse order
of creation. */
@in const(Eo_Event_Description)* desc; /*@ The description of the
event to call */
@in void *event_info; /*@ Extra event info to pass to the
callbacks */
}
- return: bool; /* @c EINA_TRUE if one of the callbacks aborted the
call, @c EINA_FALSE otherwise */
+ return: bool; /*@ @c EINA_TRUE if one of the callbacks aborted the
call, @c EINA_FALSE otherwise */
}
event_callback_forwarder_add {
/*@ Add an event callback forwarder for an event and an object. */
@@ -171,7 +171,7 @@ callbacks of the same priority are called in reverse order
of creation. */
return: free(own(iterator<Eo *> *), eina_iterator_free) @warn_unused;
}
composite_attach @beta {
- /**
+ /*@
* @brief Make an object a composite object of another.
*
* The class of comp_obj must be part of the extensions of the
class of the parent.
@@ -188,7 +188,7 @@ callbacks of the same priority are called in reverse order
of creation. */
return: bool; /*@ EINA_TRUE if successfull. EINA_FALSE otherwise. */
}
composite_detach @beta {
- /**
+ /*@
* @brief Detach a composite object from another object.
*
* This functions also sets the parent of comp_obj to @c NULL.
@@ -203,7 +203,7 @@ callbacks of the same priority are called in reverse order
of creation. */
return: bool; /*@ EINA_TRUE if successfull. EINA_FALSE otherwise. */
}
composite_part_is @beta {
- /**
+ /*@
* @brief Check if an object is part of a composite object.
*
* @see eo_composite_attach()
diff --git a/src/lib/evas/canvas/evas_3d_mesh.eo
b/src/lib/evas/canvas/evas_3d_mesh.eo
index 7cc8b97..324aaa0 100644
--- a/src/lib/evas/canvas/evas_3d_mesh.eo
+++ b/src/lib/evas/canvas/evas_3d_mesh.eo
@@ -75,7 +75,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
frame_vertex_data_unmap {
- /*
+ /*@
Unmap the vertex buffer of the key frame of the given mesh.
@see evas_3d_mesh_frame_vertex_data_map()
@@ -90,7 +90,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
frame_vertex_stride_get @const {
- /*
+ /*@
Get the vertex buffer stride of the key frame of the given mesh.
This function returns valid stride only when the vertex buffer is
mapped.
@@ -111,7 +111,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
index_data_set {
- /*
+ /*@
Set the vertex index data of the given mesh.
When the index data is set, Evas 3D assembles vertices using the
index data.
@@ -133,7 +133,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
index_data_copy_set {
- /*
+ /*@
Set the vertex index data of the given mesh by copying from a
buffer.
This function allocates internal index buffer any copy data from
the given
@@ -151,7 +151,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
index_format_get @const {
- /*
+ /*@
Get the format of the index data of the given mesh.
@@ -171,7 +171,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
index_count_get @const {
- /*
+ /*@
Get the count of the index data of the given mesh.
This function returns the index count of the last called data_set
function.
@@ -187,7 +187,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
index_data_map {
- /*
+ /*@
Map the index buffer of the given mesh.
evas_3d_mesh_index_data_unmap() should be called after
modifications. If the
@@ -205,7 +205,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
index_data_unmap {
- /*
+ /*@
Unmap the index buffer of the given mesh.
@see evas_3d_mesh_index_data_map()
@@ -215,7 +215,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
frame_add {
- /*
+ /*@
Add a key frame to the given mesh.
@param mesh The given mesh.
@@ -231,7 +231,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
frame_del {
- /*
+ /*@
Delete a key frame from the given mesh.
@param mesh The given mesh.
@@ -247,7 +247,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
fog_color_set {
- /*
+ /*@
Set the fog color and density for the given mesh.
@ingroup Evas_3D_Mesh
*/
@@ -259,7 +259,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
}
fog_color_get {
- /*
+ /*@
Set the fog color and density for the given mesh.
@ingroup Evas_3D_Mesh
*/
@@ -271,7 +271,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
}
blending_func_set {
- /*
+ /*@
Set the blending function for given mesh
@ingroup Evas_3D_Mesh
*/
@@ -281,7 +281,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
}
blending_func_get {
- /*
+ /*@
Get blending blending function for given mesh
@see eavs_3d_mesh_blending_func_set()
@ingroup Evas_3D_Mesh
@@ -294,7 +294,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
@property shade_mode {
set {
- /**
+ /*@
* Set the shade mode of the given mesh.
*
* Default shade mode is EVAS_3D_SHADE_MODE_VERTEX_COLOR.
@@ -303,7 +303,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
*/
}
get {
- /**
+ /*@
* Get the shade mode of the given mesh.
*
* @see eavs_3d_mesh_shade_mode_set()
@@ -317,14 +317,14 @@ class Evas_3D_Mesh (Evas_3D_Object,
Evas.Common_Interface, Efl.File)
}
@property color_pick_enable {
set {
- /**
+ /*@
* Set posibility color picking.
*
* @ingroup Evas_3D_Mesh
*/
}
get {
- /**
+ /*@
* Get status of color picking of the mesh.
*
* @see color_pick_enable_set()
@@ -338,7 +338,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
@property vertex_count {
set {
- /**
+ /*@
* Set the vertex count of the given mesh.
*
* Each key frame should have same vertex count to be properly
interpolated.
@@ -351,7 +351,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
*/
}
get {
- /**
+ /*@
* Get the vertex count of the given mesh.
*
* @see evas_3d_mesh_vertex_count_set()
@@ -365,7 +365,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
}
@property fog_enable {
set {
- /**
+ /*@
* Enable or disable fog effect for given mesh.
*
* Default fog is disabled.
@@ -374,7 +374,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
*/
}
get {
- /**
+ /*@
* Get the enable status of fog effect for given mesh
*
* @see fog_enable_set()
@@ -389,7 +389,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
@property alpha_test_enable {
set {
- /**
+ /*@
* Get the enable status of alpha test for given mesh
*
* Default alpha test disabled.
@@ -398,7 +398,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
*/
}
get {
- /**
+ /*@
* Get the enable status of alpha test for given mesh
*
* @see alpha_test_enable_set()
@@ -413,7 +413,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
@property alpha_func {
set {
- /*
+ /*@
* The alpha test discards fragments depending on the outcome of a
comparison
* between an incoming fragment's alpha value and a constant
reference value
* This func specifies the reference value and the comparison
function.
@@ -422,7 +422,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
*/
}
get {
- /*
+ /*@
* Get the reference value and the comparison function for alpha
testing
*
* @see eavs_3d_mesh_alpha_test_param_set()
@@ -438,7 +438,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
@property blending_enable {
set {
- /**
+ /*@
* Enable or disable blending for given mesh.
*
* Default blending disabled.
@@ -447,7 +447,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
*/
}
get {
- /**
+ /*@
* Get blending enable status for given mesh.
*
* @see eavs_3d_mesh_blending_enable_set()
@@ -462,7 +462,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
@property frame_material {
set {
- /**
+ /*@
Set the material of the key frame of the given mesh.
Setting different materials for each key frame is useful for
doing animations
@@ -472,7 +472,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
*/
}
get {
- /**
+ /*@
Get the material of the key frame of the given mesh.
@see evas_3d_mesh_frame_material_set()
@@ -490,7 +490,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
@property vertex_assembly {
set {
- /*
+ /*@
Set the vertex assembly of the given mesh.
Vertex assembly defines how the engine organizes vertices into
geometric
@@ -502,7 +502,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface,
Efl.File)
*/
}
get {
- /*
+ /*@
Get the vertex assembly of the given mesh.
@see evas_3d_mesh_vertex_assembly_set()
--
