rggammon
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

eolian: fix up remaining doc comments in the tree

This commit is contained in:
Daniel Kolesa 2015-05-11 15:37:19 +01:00
parent 8c51033d49
commit 3dc27cb482
8 changed files with 100 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/lib/ecore_audio/ecore_audio.eo
View File

@ -35,7 +35,7 @@ class Ecore_Audio (Eo.Base)
@since 1.8 */
}
values {
bool paused; /*ret EINA_TRUE if object is paused, EINA_FALSE if not*/
bool paused; /*@ ret EINA_TRUE if object is paused, EINA_FALSE if not*/
}
}
@property volume {
@ -52,7 +52,7 @@ class Ecore_Audio (Eo.Base)
@since 1.8 */
}
values {
double volume; /*The volume*/
double volume; /*@ The volume */
}
}
@property source {
@ -64,7 +64,7 @@ class Ecore_Audio (Eo.Base)
the libsndfile class accepts WAV, OGG, FLAC files as source.
@since 1.8 */
return: bool; /*EINA_TRUE if the source was set correctly (i.e. the file was opened), EINA_FALSE otherwise*/
return: bool; /*@ EINA_TRUE if the source was set correctly (i.e. the file was opened), EINA_FALSE otherwise*/
}
get {
/*@
@ -73,7 +73,7 @@ class Ecore_Audio (Eo.Base)
@since 1.8 */
}
values {
const(char)* source; /*The source to set to (i.e. file, URL, device)*/
const(char)* source; /*@ The source to set to (i.e. file, URL, device)*/
}
}
@property format {
@ -85,7 +85,7 @@ class Ecore_Audio (Eo.Base)
ECORE_AUDIO_FORMAT_AUTO
@since 1.8 */
return: bool; /*EINA_TRUE if the format was supported, EINA_FALSE otherwise*/
return: bool; /*@ EINA_TRUE if the format was supported, EINA_FALSE otherwise*/
}
get {
/*@
@ -97,7 +97,7 @@ class Ecore_Audio (Eo.Base)
@since 1.8 */
}
values {
Ecore_Audio_Format format; /*The format of the object*/
Ecore_Audio_Format format; /*@ The format of the object*/
}
}
vio_set {
@ -106,9 +106,9 @@ class Ecore_Audio (Eo.Base)
@since 1.8 */
params {
Ecore_Audio_Vio *vio; /*The @ref Ecore_Audio_Vio struct with the function callbacks*/
void *data; /*User data to pass to the VIO functions*/
eo_key_data_free_func free_func; /*This function takes care to clean up @ref data when he VIO is destroyed. NULL means do nothing.*/
Ecore_Audio_Vio *vio; /*@ The @ref Ecore_Audio_Vio struct with the function callbacks*/
void *data; /*@ User data to pass to the VIO functions*/
eo_key_data_free_func free_func; /*@ This function takes care to clean up @ref data when he VIO is destroyed. NULL means do nothing.*/
}
}
}

34
src/lib/ecore_audio/ecore_audio_in.eo
View File

@ -18,7 +18,7 @@ class Ecore_Audio_In (Ecore_Audio)
@since 1.8 */
}
values {
double speed; /*The speed, 1.0 is the default*/
double speed; /*@ The speed, 1.0 is the default*/
}
}
@property samplerate {
@ -35,7 +35,7 @@ class Ecore_Audio_In (Ecore_Audio)
@since 1.8 */
}
values {
int samplerate; /*The samplerate in Hz*/
int samplerate; /*@ The samplerate in Hz*/
}
}
@property channels {
@ -52,7 +52,7 @@ class Ecore_Audio_In (Ecore_Audio)
@since 1.8 */
}
values {
int channels; /*The number of channels*/
int channels; /*@ The number of channels*/
}
}
@property preloaded {
@ -69,7 +69,7 @@ class Ecore_Audio_In (Ecore_Audio)
@since 1.8 */
}
values {
bool preloaded; /*EINA_TRUE if the input should be cached, EINA_FALSE otherwise*/
bool preloaded; /*@ EINA_TRUE if the input should be cached, EINA_FALSE otherwise*/
}
}
@property looped {
@ -90,7 +90,7 @@ class Ecore_Audio_In (Ecore_Audio)
@since 1.8 */
}
values {
bool looped; /*EINA_TRUE if the input should be looped, EINA_FALSE otherwise*/
bool looped; /*@ EINA_TRUE if the input should be looped, EINA_FALSE otherwise*/
}
}
@property length {
@ -110,7 +110,7 @@ class Ecore_Audio_In (Ecore_Audio)
@since 1.8 */
}
values {
double length; /*The length of the input in seconds*/
double length; /*@ The length of the input in seconds*/
}
}
@property output {
@ -121,7 +121,7 @@ class Ecore_Audio_In (Ecore_Audio)
@since 1.8 */
}
values {
Eo *output; /*The output*/
Eo *output; /*@ The output*/
}
}
@property remaining {
@ -132,7 +132,7 @@ class Ecore_Audio_In (Ecore_Audio)
@since 1.8 */
}
values {
double remaining; /*The amount of time in seconds left to play*/
double remaining; /*@ The amount of time in seconds left to play*/
}
}
read {
@ -140,10 +140,10 @@ class Ecore_Audio_In (Ecore_Audio)
Read from the input
@since 1.8 */
return: ssize; /*The amount of samples written to buf*/
return: ssize; /*@ The amount of samples written to buf*/
params {
@in void *buf; /*The buffer to read into*/
@in size len; /*The amount of samples to read*/
@in void *buf; /*@ The buffer to read into*/
@in size len; /*@ The amount of samples to read*/
}
}
read_internal {
@ -151,10 +151,10 @@ class Ecore_Audio_In (Ecore_Audio)
Internal read function
@since 1.8 */
return: ssize; /*The amount of samples written to buf*/
return: ssize; /*@ The amount of samples written to buf*/
params {
@in void *buf; /*The buffer to read into*/
@in size len; /*The amount of samples to read*/
@in void *buf; /*@ The buffer to read into*/
@in size len; /*@ The amount of samples to read*/
}
}
seek {
@ -162,10 +162,10 @@ class Ecore_Audio_In (Ecore_Audio)
Seek within the input
@since 1.8 */
return: double; /*The current absolute position in seconds within the input*/
return: double; /*@ The current absolute position in seconds within the input*/
params {
@in double offs; /*The offset in seconds*/
@in int mode; /*mode The seek mode. Is absolute with SEEK_SET, relative to the
@in double offs; /*@ The offset in seconds*/
@in int mode; /*@ mode The seek mode. Is absolute with SEEK_SET, relative to the
current position with SEEK_CUR and relative to the end with SEEK_END.*/
}
}

10
src/lib/ecore_audio/ecore_audio_out.eo
View File

@ -9,9 +9,9 @@ class Ecore_Audio_Out (Ecore_Audio)
Attach an input to an output
@since 1.8 */
return: bool; /*EINA_TRUE if the input was attached, EINA_FALSE otherwise*/
return: bool; /*@ EINA_TRUE if the input was attached, EINA_FALSE otherwise*/
params {
@in Eo *input; /*The input to attach to the output*/
@in Eo *input; /*@ The input to attach to the output*/
}
}
input_detach {
@ -19,9 +19,9 @@ class Ecore_Audio_Out (Ecore_Audio)
Detach an input from an output
@since 1.8 */
return: bool; /*EINA_TRUE if the input was detached, EINA_FALSE otherwise*/
return: bool; /*@ EINA_TRUE if the input was detached, EINA_FALSE otherwise*/
params {
@in Eo *input; /*he input to detach to the output*/
@in Eo *input; /*@ The input to detach to the output*/
}
}
inputs_get {
@ -29,7 +29,7 @@ class Ecore_Audio_Out (Ecore_Audio)
Returns the list of all attached inputs
@since 1.8 */
return: list<Eo*> *; /*An @ref Eina_List of the inputs that are attached to the output*/
return: list<Eo*> *; /*@ An @ref Eina_List of the inputs that are attached to the output*/
}
}
implements {

4
src/lib/evas/canvas/efl_vg_base.eo
View File

@ -36,8 +36,8 @@ abstract Efl.VG.Base (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack)
*/
}
values {
double x; /* @origin x position */
double y; /* @origin y position */
double x; /*@ @origin x position */
double y; /*@ @origin y position */
}
}
@property mask {

14
src/lib/evas/canvas/evas_3d_material.eo
View File

@ -4,7 +4,7 @@ class Evas_3D_Material (Evas_3D_Object, Evas.Common_Interface)
data: Evas_3D_Material_Data;
methods {
color_set {
/*
/*@
Set the material attribute color of the given material.
Material color is used also when texture map is enabled. The colors will be
@ -33,7 +33,7 @@ class Evas_3D_Material (Evas_3D_Object, Evas.Common_Interface)
}
color_get @const {
/*
/*@
Get the material attribute color of the given material.
@see evas_3d_material_color_set()
@ -51,7 +51,7 @@ class Evas_3D_Material (Evas_3D_Object, Evas.Common_Interface)
@property enable {
set {
/*
/*@
Set the material attribute enable flag of the given material.
You might want to disable some material reflection contribution. For
@ -64,7 +64,7 @@ class Evas_3D_Material (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get the material attribute enable flag of the given material.
@see evas_3d_material_enable_set()
@ -83,7 +83,7 @@ class Evas_3D_Material (Evas_3D_Object, Evas.Common_Interface)
@property shininess {
set {
/*
/*@
Set the shininess of the given material.
Shininess is only used when specular attribute is enabled. Higher shininess
@ -97,7 +97,7 @@ class Evas_3D_Material (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get the shininess of the given material.
@see evas_3d_material_shininess_set()
@ -124,7 +124,7 @@ class Evas_3D_Material (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get the texture of the given material.
@see evas_3d_material_texture_set()

65
src/lib/evas/canvas/evas_3d_node.eo
View File

@ -11,7 +11,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
}
type_get @const {
/*
/*@
Get the type of the given node.
@return The type of the given node.
@ -23,7 +23,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
return: Evas_3D_Node_Type ;
}
member_add {
/*
/*@
Add a member node to the given node.
Nodes can be constructed into N-ary tree structure like other ordinary scene
@ -39,7 +39,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
}
member_del {
/*
/*@
Delete a member node from the given node.
@see evas_3d_node_member_add()
@ -53,7 +53,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
parent_get @const {
/*
/*@
Get the parent node of the given node.
@return The parent node of the given node.
@ -66,7 +66,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
member_list_get @const {
/*
/*@
Get the list of member nodes of the given node.
@return The list of member nodes if any or @c NULL if there are none.
@ -78,8 +78,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
return: const(list<Evas_3D_Node *>)*;
}
position_set {
/*
/*@
Set the position of the given node.
According to the inheritance flag, (x, y, z) can be a world space position or
@ -98,7 +97,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
}
orientation_set {
/*
/*@
Set the orientation of the given node using quaternion.
According the the inheritance flag, (w, x, y, z) can be a world space
@ -119,7 +118,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
orientation_angle_axis_set {
/*
/*@
Set the orientation of the given node using axis-angle.
@param node The given node.
@ -141,7 +140,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
scale_set {
/*
/*@
Set the scale of the given node.
@param node The given node.
@ -167,7 +166,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
position_get @const {
/*
/*@
Get the position of the given node.
@param node The given node.
@ -188,7 +187,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
orientation_get @const {
/*
/*@
Get the orientation of the given node as quaternion.
@param node The given node.
@ -211,7 +210,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
scale_get @const {
/*
/*@
Get the scale of the given node.
@param node The given node.
@ -232,7 +231,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
look_at_set {
/*
/*@
Rotate the given node to look at desired position.
@param node The given node.
@ -267,7 +266,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
mesh_add {
/*
/*@
Add a mesh to the given node.
@param node The given node.
@ -286,7 +285,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
mesh_del {
/*
/*@
Delete a mesh from the given node.
@param node The given node.
@ -305,7 +304,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
mesh_list_get @const {
/*
/*@
Get the list of meshes of the given node.
@param node The given node.
@ -323,7 +322,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
bounding_box_get{
/*
/*@
Get axis-aligned bounding box (AABB) of the given node.
*
* @param node The given node.
@ -347,7 +346,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
}
bounding_sphere_get {
/*
/*@
Get bounding sphere of the given node.
*
* @param node The given node.
@ -370,7 +369,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@property position_inherit {
set {
/*
/*@
Set the position inheritance flag of the given node.
@param node The given node.
@ -384,7 +383,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get the position inheritance flag of the given node.
@param node The given node.
@ -402,7 +401,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@property orientation_inherit {
set {
/*
/*@
Set the orientation inheritance flag of the given node.
@param node The given node.
@ -417,7 +416,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get the orientation inheritance flag of the given node.
@param node The given node.
@ -435,7 +434,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@property scale_inherit {
set {
/*
/*@
Set the scale inheritance flag of the given node.
@param node The given node.
@ -449,7 +448,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get the scale inheritance flag of the given node.
@param node The given node.
@ -467,7 +466,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@property camera {
set {
/*
/*@
Set a camera to the given node.
@param node The given node.
@ -482,7 +481,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get the camera of the given node.
@param node The given node.
@ -500,7 +499,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@property light {
set {
/*
/*@
Set the light of the given node.
@param node The given node.
@ -515,7 +514,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get the light of the given node.
@param node The given node.
@ -533,7 +532,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@property mesh_frame {
set {
/*
/*@
Set the animation frame number of the given node for the given mesh.
@param node The given node.
@ -551,7 +550,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Set the animation frame number of the given node for the given mesh.
@param node The given node.
@ -576,7 +575,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@property billboard_target {
set {
/*
/*@
Set behavior of node like billboard object.
@param node The given node.
@ -586,7 +585,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get the target node for billboard object.
@param node The given node.

30
src/lib/evas/canvas/evas_3d_scene.eo
View File

@ -4,7 +4,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
data: Evas_3D_Scene_Data;
methods {
size_set {
/*
/*@
Set the resolution of a scene.
A scene should be rendered to be displayed through an image objects. The
@ -19,7 +19,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
}
size_get @const {
/*
/*@
Get the internal resolution of a scene.
@ingroup Evas_3D_Scene
@ -31,7 +31,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
}
background_color_set {
/*
/*@
Set the background color of a scene.
Background color defines initial color of pixels before a scene is rendered.
@ -51,7 +51,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
}
background_color_get @const {
/*
/*@
Get the background color of a scene.
@ingroup Evas_3D_Scene
@ -65,7 +65,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
}
pick @const {
/*
/*@
Get information on the most front visible mesh for the given position.
(x, y) is the screen coordinate of the given scene. That is, left-top is
@ -86,7 +86,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
}
exist @const {
/*
/*@
Search given node in the given position.
@ingroup Evas_3D_Scene
@ -100,7 +100,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
}
pick_member_list_get @const {
/*
/*@
Get list of the all root members from scene in the given position.
@ingroup Evas_3D_Scene
@ -112,7 +112,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
}
}
shadows_enable_set {
/*
/*@
Enable or disable shadows on given scene
If shadows_enabled @c EINA_TRUE, the objects in the scene can throw shadow to another objects located behind them.
@ -126,7 +126,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
}
shadows_enable_get @const {
/*
/*@
Get shadows enabled status for given scene.
@return The shadows enabled status.
@ -137,7 +137,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
}
}
color_pick_enable_get @const {
/*
/*@
Get status of color picking of the scene.
@ingroup Evas_3D_Scene
@ -147,7 +147,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
}
}
color_pick_enable_set {
/*
/*@
Set posibility color picking.
@ingroup Evas_3D_Scene
@ -160,14 +160,14 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
@property root_node {
set {
/*
/*@
Set the root node of a scene.
@ingroup Evas_3D_Scene
*/
}
get {
/*
/*@
Get the root node of a scene.
@return The root node of the given scene.
@ -182,14 +182,14 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
@property camera_node {
set {
/*
/*@
Set the camera node of a scene.
@ingroup Evas_3D_Scene
*/
}
get {
/*
/*@
Get the camera node of a scene.
@return The camera node of the given scene.

26
src/lib/evas/canvas/evas_3d_texture.eo
View File

@ -5,7 +5,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
methods {
@property source_visible {
set {
/*
/*@
Set the visibility flag of the source evas object of the given texture.
Recommend to call evas_object_show() on the source object and controll the
@ -19,7 +19,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get the visibility flag of the source evas object of the given texture.
@see evas_3d_texture_source_visible_set()
@ -33,7 +33,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
}
@property atlas_enable {
set {
/*
/*@
Set enable flag to generation texture unit with support atlas.
Use this flag only in case not normalize texture coordinates.
@ -44,7 +44,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
*/
}
get {
/*
/*@
Get enable flag of generation texture unit with support atlas.
@ingroup Evas_3D_Texture
@ -55,7 +55,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
}
}
data_set {
/*
/*@
Set the data of the given texture.
@see evas_3d_texture_file_set()
@ -72,7 +72,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
}
file_set {
/*
/*@
Set the data of the given texture from file.
@ingroup Evas_3D_Texture
@ -85,7 +85,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
}
source_set {
/*
/*@
Set the data of the given texture from an evas object.
Evas 3D support using existing evas object as a texture source. This feature
@ -102,7 +102,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
}
color_format_get @const {
/*
/*@
Get the color format of the given texture.
EVAS_3D_COLOR_FORMAT_RGBA will be returned if the texture has source object.
@ -118,7 +118,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
}
size_get @const {
/*
/*@
Get the size of the given texture.
If the texture has source object, the size of the source object will be
@ -137,7 +137,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
}
wrap_set {
/*
/*@
Set the wrap mode of the given texture.
If the texture coordinate exceed range [0.0, 1.0] the values are modified
according to the wrap mode.
@ -153,7 +153,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
}
wrap_get {
/*
/*@
Get the wrap mode of the given texture.
@see evas_3d_texture_wrap_set()
@ -168,7 +168,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
}
filter_set {
/*
/*@
Set the filter of the given texture.
Default filters are both EVAS_3D_TEXTURE_FILTER_NEAREST for s and t.
@ -183,7 +183,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
}
filter_get @const {
/*
/*@
Get the filter of the given texture.
@param texture The given texture.