enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 1 Projects Releases Wiki Activity

eolian: more consistent syntax 

"legacy foo" is now "legacy: foo" and "return foo" is now "return: foo".
This commit is contained in:
Daniel Kolesa 2014-08-07 16:58:45 +01:00
parent 7ef5c78792
commit 459638c2b9
33 changed files with 294 additions and 292 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/examples/eolian_cxx/colourable.eo
View File

@ -29,7 +29,7 @@ class Colourable (Eo.Base)
params {
@in int mask; /*@ The colour mask to be applied to current RGB value. */
}
return int; /*@ The RGB colour. */
return: int; /*@ The RGB colour. */
}
}
properties {

6
src/lib/ecore/ecore_poller.eo
View File

@ -20,8 +20,8 @@ class Ecore.Poller (Eo.Base)
This allows the changing of a poller's polling interval. It is useful when
you want to alter a poll rate without deleting and re-creating a poller. */
legacy ecore_poller_poller_interval_set;
return bool;
legacy: ecore_poller_poller_interval_set;
return: bool;
}
get {
/*@
@ -29,7 +29,7 @@ class Ecore.Poller (Eo.Base)
@return Returns the interval, in ticks, that @p poller polls at.
This returns a poller's polling interval, or 0 on error. */
legacy ecore_poller_poller_interval_get;
legacy: ecore_poller_poller_interval_get;
}
values {
int interval; /*@ The tick interval to set; must be a power of 2 and <= 32768. */

2
src/lib/ecore/ecore_timer.eo
View File

@ -43,7 +43,7 @@ class Ecore.Timer (Eo.Base)
pending {
get {
/*@ Get the pending time regarding a timer. */
return double;
return: double;
}
}
}

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

@ -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 {
/*@
@ -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 {
/*@

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

@ -142,7 +142,7 @@ 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*/
@ -153,7 +153,7 @@ 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*/
@ -164,7 +164,7 @@ 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

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

@ -9,7 +9,7 @@ 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*/
}
@ -19,7 +19,7 @@ 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*/
}
@ -29,7 +29,7 @@ class Ecore_Audio_Out (Ecore_Audio)
Returns the list of all attached inputs
@since 1.8 */
return Eina.List *; /*An @ref Eina_List of the inputs that are attached to the output*/
return: Eina.List *; /*An @ref Eina_List of the inputs that are attached to the output*/
}
}
implements {

166
src/lib/edje/edje_object.eo
View File

@ -162,7 +162,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_add()
@see edje_object_file_get()
@see edje_object_mmap_set() */
return bool;
return: bool;
}
get {
/*@
@ -203,7 +203,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_scale_get()
@see edje_scale_get() for more details */
return bool;
return: bool;
}
get {
/*@
@ -248,7 +248,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_file_get()
@see edje_object_mmap_set()
@since 1.8 */
return bool;
return: bool;
}
values {
const(Eina.File)* file; /*@ The Eina.File pointing to the EDJ file to load @p from */
@ -298,7 +298,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return @c EINA_TRUE, on success or @c EINA_FALSE, on error
This function sets the text class for the Edje. */
return bool;
return: bool;
}
values {
const(char)* text_class; /*@ The text class name */
@ -314,7 +314,7 @@ class Edje.Object (Evas.Smart_Clipped)
This is frequently used with the user cursor.
@return True on success, false on error. */
return bool;
return: bool;
}
values {
const(char)* part; /*@ The part containing the object. */
@ -346,7 +346,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return @c EINA_TRUE on success, @c EINA_FALSE otherwise
@since 1.2 */
return bool;
return: bool;
}
values {
const(char)* part; /*@ The part name */
@ -442,7 +442,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return A list all accessibility part names on @p obj
@since 1.7.0 */
return Eina.List *;
return: Eina.List *;
}
}
load_error {
@ -468,7 +468,7 @@ class Edje.Object (Evas.Smart_Clipped)
check for the reason of failure with this one.
@see edje_load_error_str() */
return Edje_Load_Error;
return: Edje_Load_Error;
}
}
size_max {
@ -521,7 +521,7 @@ class Edje.Object (Evas.Smart_Clipped)
Removes all object from the table indicated by part, except the
internal ones set from the theme. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in bool clear; /*@ If set, will delete subobjs on remove */
@ -533,7 +533,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return @c EDJE_EXTERNAL_PARAM_TYPE_MAX on errors, or another value
from #Edje_External_Param_Type on success. */
return Edje_External_Param_Type;
return: Edje_External_Param_Type;
params {
@in const(char)* part; /*@ The part name */
@out const(char) param; /*@ the parameter name to use. */
@ -559,7 +559,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The part state:\n
"default" for the default state\n
"" for other states */
return const(char)*;
return: const(char)*;
params {
@in const(char)* part; /*@ The part name */
@out double val_ret;
@ -579,7 +579,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The same data pointer if successful, or NULL otherwise
@since 1.2.0 */
return void *;
return: void *;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Markup_Filter_Cb func; /*@ The function callback to remove */
@ -598,7 +598,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_drag_step_get() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in double dx; /*@ The x step amount */
@ -613,7 +613,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_drag_step_set() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part */
@out double dx; /*@ The x step increment pointer */
@ -629,7 +629,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The input method context (Ecore_IMF_Context *) in entry
@since 1.2.0 */
return void *;
return: void *;
params {
@in const(char)* part; /*@ The part name */
}
@ -650,7 +650,7 @@ class Edje.Object (Evas.Smart_Clipped)
This function returns the style associated with the textblock part.
@since 1.2.0 */
return const(char)*;
return: const(char)*;
params {
@in const(char)* part; /*@ The part name */
}
@ -670,8 +670,8 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_signal_callback_add().
@see edje_object_signal_callback_del_full(). */
legacy null;
return void *;
legacy: null;
return: void *;
params {
@in const(char)* emission; /*@ The emission string. */
@in const(char)* source; /*@ The source string. */
@ -684,7 +684,7 @@ class Edje.Object (Evas.Smart_Clipped)
@brief Advances the cursor to the next cursor position.
@see evas_textblock_cursor_char_next */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Cursor cur; /*@ The edje cursor to advance */
@ -731,7 +731,7 @@ class Edje.Object (Evas.Smart_Clipped)
@note On failure, this function will make all non-@c NULL geometry
pointers' pointed variables be set to zero. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The Edje part's name */
@out Evas_Coord x; /*@ A pointer to a variable where to store the part's x
@ -763,7 +763,7 @@ class Edje.Object (Evas.Smart_Clipped)
This function return a list of Evas_Textblock_Rectangle item
rectangles. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in const(char)* item; /*@ The item name */
@ -781,7 +781,7 @@ class Edje.Object (Evas.Smart_Clipped)
Removes an object from the table indicated by part. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Evas_Object *child_obj; /*@ The object to pack in */
@ -807,7 +807,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The same data pointer if successful, or NULL otherwise */
return void *;
return: void *;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Text_Filter_Cb func; /*@ The function callback to remove */
@ -875,7 +875,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_box_remove()
@see edje_object_part_box_remove_all() */
return Evas_Object *;
return: Evas_Object *;
params {
@in const(char)* part; /*@ The part name */
@in uint pos; /*@ The position index of the object (starts counting from 0) */
@ -909,7 +909,7 @@ class Edje.Object (Evas.Smart_Clipped)
@note On failure, this function will make all non-@c NULL geometry
pointers' pointed variables be set to zero. */
return bool;
return: bool;
params {
@out Evas_Coord x; /*@ A pointer to a variable where to store the parts region's
x coordinate */
@ -939,7 +939,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_drag_value_get() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in double dx; /*@ The x value */
@ -956,7 +956,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_drag_value_set()
Gets the drag location values. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@out double dx; /*@ The X value pointer */
@ -989,7 +989,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The cursor position
@since 1.1.0 */
return int;
return: int;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Cursor cur; /*@ The cursor to get the position */
@ -1006,7 +1006,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_thaw() */
return int;
return: int;
}
part_text_cursor_content_get @const {
/*@
@ -1016,7 +1016,7 @@ class Edje.Object (Evas.Smart_Clipped)
You must free the return (if not NULL) after you are done with it.
@return The character string pointed to (may be a multi-byte utf8 sequence) terminated by a nul byte. */
return char *;
return: char *;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Cursor cur; /*@ The cursor to use */
@ -1046,7 +1046,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_text_input_panel_layout_set
@since 1.1 */
return Edje_Input_Panel_Layout;
return: Edje_Input_Panel_Layout;
params {
@in const(char)* part; /*@ The part name */
}
@ -1059,7 +1059,7 @@ class Edje.Object (Evas.Smart_Clipped)
Packs an object into the table indicated by part. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Evas_Object *child_obj; /*@ The object to pack in */
@ -1090,7 +1090,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return input panel language type
@since 1.2.0 */
return Edje_Input_Panel_Lang;
return: Edje_Input_Panel_Lang;
params {
@in const(char)* part; /*@ The part name */
}
@ -1102,7 +1102,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return @c EINA_TRUE get some data, @c EINA_FALSE on failure
Retrieves the size of the table in number of columns and rows. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@out int cols; /*@ Pointer where to store number of columns (can be NULL) */
@ -1126,7 +1126,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The externally created object, or NULL if there is none or
part is not an external. */
return Evas_Object *;
return: Evas_Object *;
params {
@in const(char)* part; /*@ The part name */
}
@ -1137,7 +1137,7 @@ class Edje.Object (Evas.Smart_Clipped)
The @p content string must not be NULL. Its actual value depends on the
code providing the EXTERNAL. */
return Evas_Object *;
return: Evas_Object *;
params {
@in const(char)* part; /*@ The name of the part holding the EXTERNAL */
@out const(char) content; /*@ A string identifying which content from the EXTERNAL to get */
@ -1158,7 +1158,7 @@ class Edje.Object (Evas.Smart_Clipped)
@note Use @c EINA_TRUE on scenarios where you don't need
the image data preloaded anymore. */
return bool;
return: bool;
params {
@in bool cancel; /*@ @c EINA_FALSE will add it the preloading work queue,
@c EINA_TRUE will remove it (if it was issued before). */
@ -1182,7 +1182,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return EINA_TRUE if it supports or EINA_FALSE otherwise
@since 1.1.0 */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
}
@ -1208,7 +1208,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_box_prepend()
@see edje_object_part_box_insert_before() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Evas_Object *child; /*@ The object to insert */
@ -1224,7 +1224,7 @@ class Edje.Object (Evas.Smart_Clipped)
This function return a list of Evas_Textblock_Rectangle anchor
rectangles. */
return const(Eina.List)*;
return: const(Eina.List)*;
params {
@in const(char)* part; /*@ The part name */
@in const(char)* anchor; /*@ The anchor name */
@ -1234,7 +1234,7 @@ class Edje.Object (Evas.Smart_Clipped)
/*@
@brief Moves the cursor to the char below the current cursor position. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Cursor cur; /*@ the edje cursor to work on */
@ -1252,7 +1252,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_drag_page_get() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in double dx; /*@ The x page step increment */
@ -1266,7 +1266,7 @@ class Edje.Object (Evas.Smart_Clipped)
Gets the x,y page step increments for the dragable object.
@see edje_object_part_drag_page_set() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@out double dx; /*@ The dx page increment pointer */
@ -1286,7 +1286,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_box_insert_before()
@see edje_object_part_box_insert_at() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Evas_Object *child; /*@ The object to prepend */
@ -1346,7 +1346,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_text_input_panel_layout_variation_set
@since 1.8 */
return int;
return: int;
params {
@in const(char)* part; /*@ The part name */
}
@ -1401,7 +1401,7 @@ class Edje.Object (Evas.Smart_Clipped)
query information about its current state (with @c
evas_object_visible_get() or @c evas_object_color_get() for
example), though. */
return const(Evas_Object)*;
return: const(Evas_Object)*;
params {
@in const(char)* part; /*@ The Edje part's name */
}
@ -1417,7 +1417,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_drag_size_get() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in double dw; /*@ The drag width */
@ -1431,7 +1431,7 @@ class Edje.Object (Evas.Smart_Clipped)
Gets the dragable object size.
@see edje_object_part_drag_size_set() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@out double dw; /*@ The drag width pointer */
@ -1450,7 +1450,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The user data pointer if successful, or NULL otherwise */
return void *;
return: void *;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Text_Filter_Cb func; /*@ The function callback to remove */
@ -1468,7 +1468,7 @@ class Edje.Object (Evas.Smart_Clipped)
#EDJE_DRAG_DIR_X: Dragable in X direction\n
#EDJE_DRAG_DIR_Y: Dragable in Y direction\n
#EDJE_DRAG_DIR_XY: Dragable in X & Y directions */
return Edje_Drag_Dir;
return: Edje_Drag_Dir;
params {
@in const(char)* part; /*@ The part name */
}
@ -1482,7 +1482,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_text_unescaped_get(). */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in const(char)* text_to_escape; /*@ The text string */
@ -1501,7 +1501,7 @@ class Edje.Object (Evas.Smart_Clipped)
when done.
@see edje_object_part_text_unescaped_set(). */
return char *;
return: char *;
params {
@in const(char)* part; /*@ The part name */
}
@ -1594,7 +1594,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return EINA_TRUE if it should be disabled
@since 1.2.0 */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
}
@ -1616,7 +1616,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The autocapitalization type
@since 1.1.0 */
return Edje_Text_Autocapital_Type;
return: Edje_Text_Autocapital_Type;
params {
@in const(char)* part; /*@ The part name */
}
@ -1652,7 +1652,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return EINA_TRUE if prediction feature is allowed.
@since 1.2.0 */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
}
@ -1691,7 +1691,7 @@ class Edje.Object (Evas.Smart_Clipped)
queries for a @b global EDC data field on an EDC declaration file.
@see edje_object_file_set() */
return const(char)*;
return: const(char)*;
params {
@in const(char)* key; /*@ The data field's key string */
}
@ -1750,7 +1750,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_box_remove_at()
@see edje_object_part_box_remove_all() */
return Evas_Object *;
return: Evas_Object *;
params {
@in const(char)* part; /*@ The part name */
@in Evas_Object *child; /*@ The object to remove */
@ -1769,14 +1769,14 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_freeze() */
return int;
return: int;
}
part_swallow_get @const {
/*@
@brief Get the object currently swallowed by a part.
@return The swallowed object, or NULL if there is none. */
return Evas_Object *;
return: Evas_Object *;
params {
@in const(char)* part; /*@ The part name */
}
@ -1813,7 +1813,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The type of "return" key on the input panel
@since 1.2.0 */
return Edje_Input_Panel_Return_Key_Type;
return: Edje_Input_Panel_Return_Key_Type;
params {
@in const(char)* part; /*@ The part name */
}
@ -1823,7 +1823,7 @@ class Edje.Object (Evas.Smart_Clipped)
@brief Retrieve a child from a table
@return The child Evas_Object */
return Evas_Object *;
return: Evas_Object *;
params {
@in const(char)* part; /*@ The part name */
@in uint col; /*@ The column of the child to get */
@ -1844,7 +1844,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_box_prepend()
@see edje_object_part_box_insert_at() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Evas_Object *child; /*@ The object to insert */
@ -1873,7 +1873,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return @c EINA_TRUE if everything went fine, @c EINA_FALSE on errors. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in const(Edje_External_Param)* param; /*@ the parameter details, including its name, type and
@ -1902,7 +1902,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return @c EINA_TRUE if everything went fine and @p param members
are filled with information, @c EINA_FALSE on errors and @p
param member values are not set or valid. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@out Edje_External_Param param; /*@ the parameter details. It is used as both input and
@ -1941,7 +1941,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_box_insert_before()
@see edje_object_part_box_insert_at() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Evas_Object *child; /*@ The object to append */
@ -1989,7 +1989,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_box_remove()
@see edje_object_part_box_remove_at() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in bool clear; /*@ Delete objects on removal */
@ -2008,7 +2008,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_drag_step() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in double dx; /*@ The x step */
@ -2021,7 +2021,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return @c EINA_TRUE on success, @c EINA_FALSE otherwise */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in const(char)* text; /*@ The text string */
@ -2036,7 +2036,7 @@ class Edje.Object (Evas.Smart_Clipped)
This function returns the text associated to the object part.
@see edje_object_part_text_set(). */
return const(char)*;
return: const(char)*;
params {
@in const(char)* part; /*@ The part name */
}
@ -2059,7 +2059,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return @c EINA_TRUE if the input panel will be shown in case of only Mouse up event.
@since 1.9.0 */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
}
@ -2074,7 +2074,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_text_select_all()
@see edje_object_part_text_select_none() */
return const(char)*;
return: const(char)*;
params {
@in const(char)* part; /*@ The part name */
}
@ -2085,7 +2085,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see evas_textblock_cursor_is_format
@return EINA_TRUE if it's true, EINA_FALSE otherwise. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Cursor cur; /*@ The cursor to adjust. */
@ -2110,7 +2110,7 @@ class Edje.Object (Evas.Smart_Clipped)
@note unlike Evas, Edje colors are @b not pre-multiplied. That is,
half-transparent white is 255 255 255 128. */
return bool;
return: bool;
params {
@in const(char)* color_class;
@in int r; /*@ Object Red value */
@ -2144,7 +2144,7 @@ class Edje.Object (Evas.Smart_Clipped)
@note unlike Evas, Edje colors are @b not pre-multiplied. That is,
half-transparent white is 255 255 255 128. */
return bool;
return: bool;
params {
@in const(char)* color_class;
@out int r; /*@ Object Red value */
@ -2172,7 +2172,7 @@ class Edje.Object (Evas.Smart_Clipped)
@see edje_object_part_drag_page() */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in double dx; /*@ The x step */
@ -2183,7 +2183,7 @@ class Edje.Object (Evas.Smart_Clipped)
/*@
@brief Move the cursor to the char above the current cursor position. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Cursor cur; /*@ the edje cursor to work on */
@ -2208,7 +2208,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The list of anchors (const char *), do not modify!
This function returns a list of char anchor names. */
return const(Eina.List)*;
return: const(Eina.List)*;
params {
@in const(char)* part; /*@ The part name */
}
@ -2276,7 +2276,7 @@ class Edje.Object (Evas.Smart_Clipped)
This call is useful, for example, when one could expect or not a
given GUI element, depending on the @b theme applied to @p obj. */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part's name to check for existence in @p obj's
group */
@ -2295,7 +2295,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The user data pointer if successful, or NULL otherwise
@since 1.2.0 */
return void *;
return: void *;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Markup_Filter_Cb func; /*@ The function callback to remove */
@ -2306,7 +2306,7 @@ class Edje.Object (Evas.Smart_Clipped)
@brief Return true if the cursor points to a visible format
For example \\t, \\n, item and etc.
@see evas_textblock_cursor_format_is_visible_get */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Cursor cur; /*@ The cursor to adjust. */
@ -2330,7 +2330,7 @@ class Edje.Object (Evas.Smart_Clipped)
@brief Moves the cursor to the previous char
@see evas_textblock_cursor_char_prev */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The part name */
@in Edje_Cursor cur; /*@ the edje cursor to work on */
@ -2343,7 +2343,7 @@ class Edje.Object (Evas.Smart_Clipped)
@return The list of items (const char *), do not modify!
This function returns a list of char item names. */
return const(Eina.List)*;
return: const(Eina.List)*;
params {
@in const(char)* part; /*@ The part name */
}
@ -2381,7 +2381,7 @@ class Edje.Object (Evas.Smart_Clipped)
For more details on EDC @c SWALLOW parts, see @ref edcref "syntax
reference". */
return bool;
return: bool;
params {
@in const(char)* part; /*@ The swallow part's name */
@in Evas_Object *obj_swallow; /*@ The object to occupy that part */

8
src/lib/eo/eo_base.eo
View File

@ -80,7 +80,7 @@ Should not be used with #eo_do. Only use it with #eo_do_super. */
}
finalize {
/*@ Called at the end of #eo_add. Should not be called, just overridden. */
return Eo *; /*@ The new object created, can be NULL if the finalize func decided to abort (though it should free the created object on it's own). */
return: Eo *; /*@ The new object created, can be NULL if the finalize func decided to abort (though it should free the created object on it's own). */
}
key_data_set {
/*@ Set generic data to object. */
@ -95,7 +95,7 @@ Should not be used with #eo_do. Only use it with #eo_do_super. */
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 */
}
event_callback_del {
/*@ Del a callback with a specific data associated to it for an event. */
@ -150,7 +150,7 @@ This function registers the object handle pointed by wref to obj so when obj is
@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_priority_add {
/*@ Add a callback for an event with a specific priority.
@ -164,7 +164,7 @@ callbacks of the same priority are called in reverse order of creation. */
}
children_iterator_new {
/*@ Get an iterator on all childrens */
return Eina.Iterator *;
return: Eina.Iterator *;
}
}
implements {

2
src/lib/eolian/eo_parser.c
View File

@ -821,6 +821,7 @@ parse_return(Eo_Lexer *ls, Eina_Bool allow_void)
Eo_Ret_Def *ret = calloc(1, sizeof(Eo_Ret_Def));
ls->tmp.ret_def = ret;
eo_lexer_get(ls);
check_next(ls, ':');
if (allow_void)
ret->type = parse_type_void(ls);
else
@ -898,6 +899,7 @@ static void
parse_legacy(Eo_Lexer *ls)
{
eo_lexer_get(ls);
check_next(ls, ':');
check(ls, TOK_VALUE);
ls->tmp.legacy_def = eina_stringshare_ref(ls->t.value.s);
eo_lexer_get(ls);

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

@ -99,7 +99,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Mesh
*/
return void *;
return: void *;
params {
@in int frame; /*@ The number of the key frame. */
@in Evas_3D_Vertex_Attrib attrib; /*@ Vertex attribute ID. */
@ -135,7 +135,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Mesh
*/
return int ;
return: int;
params {
@in int frame; /*@ The number of the key frame. */
@in Evas_3D_Vertex_Attrib attrib; /*@ Vertex attribute ID. */
@ -199,7 +199,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Mesh
*/
return Evas_3D_Index_Format ;
return: Evas_3D_Index_Format;
}
index_count_get @const {
@ -215,7 +215,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Mesh
*/
return int ;
return: int;
}
index_data_map {
@ -233,7 +233,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Mesh
*/
return void * ;
return: void *;
}
index_data_unmap {
@ -303,7 +303,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Mesh
*/
return int;
return: int;
}
fog_color_set {
@ -344,7 +344,7 @@ class Evas_3D_Mesh (Evas_3D_Object, Evas.Common_Interface)
Get fog effect status for the given mesh.
@ingroup Evas_3D_Mesh
*/
return bool;
return: bool;
params {
}
}

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

@ -21,7 +21,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Node
*/
return Evas_3D_Node_Type ;
return: Evas_3D_Node_Type ;
}
member_add {
/*
@ -63,7 +63,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Node
*/
return Evas_3D_Node * ;
return: Evas_3D_Node *;
}
member_list_get @const {
@ -76,7 +76,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Node
*/
return const(Eina.List)*;
return: const(Eina.List)*;
}
position_set {
@ -320,7 +320,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Node
*/
return const(Eina.List)*;
return: const(Eina.List)*;
}
bounding_box_get{
@ -362,7 +362,7 @@ class Evas_3D_Node (Evas_3D_Object, Evas.Common_Interface)
* @ingroup Evas_3D_Node
*/
return int;
return: int;
params {
@in Evas_3D_Node *camera_node;
}

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

@ -16,7 +16,7 @@ class Evas_3D_Object (Eo.Base, Evas.Common_Interface)
/*@
Returns the type of the object.
*/
return Evas_3D_Object_Type;
return: Evas_3D_Object_Type;
}
type_set {
@ -32,7 +32,7 @@ class Evas_3D_Object (Eo.Base, Evas.Common_Interface)
/*@
Returns the status of a particular state of the object.
*/
return bool;
return: bool;
params {
@in Evas_3D_State state; /*@ State whose status is being asked */
}

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

@ -74,7 +74,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Scene
*/
return bool ;
return: bool;
params {
@in Evas_Real x; /*@ X coordinate of the picking position. */
@in Evas_Real y; /*@ Y coordinate of the picking position. */
@ -91,7 +91,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Scene
*/
return Evas_3D_Node *;
return: Evas_3D_Node *;
params {
@in Evas_Real x; /*@ X coordinate of the picking position. */
@in Evas_Real y; /*@ Y coordinate of the picking position. */
@ -105,7 +105,7 @@ class Evas_3D_Scene (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Scene
*/
return Eina.List *;
return: Eina.List *;
params {
@in Evas_Real x; /*@ X coordinate of the picking position. */
@in Evas_Real y; /*@ Y coordinate of the picking position. */

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

@ -96,7 +96,7 @@ class Evas_3D_Texture (Evas_3D_Object, Evas.Common_Interface)
@ingroup Evas_3D_Texture
*/
return Evas_3D_Color_Format ;
return: Evas_3D_Color_Format;
}
size_get @const {

68
src/lib/evas/canvas/evas_box.eo
View File

@ -200,8 +200,8 @@ class Evas.Box (Evas.Smart_Clipped)
}
internal_remove {
/*@ No description supplied by the EAPI. */
return Evas_Object *;
legacy null;
return: Evas_Object *;
legacy: null;
params {
@in Evas_Object *child;
}
@ -220,7 +220,7 @@ class Evas.Box (Evas.Smart_Clipped)
}
internal_option_free {
/*@ No description supplied by the EAPI. */
legacy null;
legacy: null;
params {
@in Evas_Object_Box_Option *opt;
}
@ -244,7 +244,7 @@ class Evas.Box (Evas.Smart_Clipped)
@note This call will trigger the box's
_Evas_Object_Box_Api.insert_after smart function. */
return Evas_Object_Box_Option *;
return: Evas_Object_Box_Option *;
params {
@in Evas_Object *child @nonull; /*@ A child Evas object to be made a member of @p o */
@in const(Evas_Object)* reference @nonull; /*@ The child object to place this new one after */
@ -261,7 +261,7 @@ class Evas.Box (Evas.Smart_Clipped)
each of @p o's child objects, in sequence. If, and only if, all
those calls succeed, so does this one. */
return bool;
return: bool;
params {
@in bool clear; /*@ if true, it will delete just removed children. */
}
@ -274,7 +274,7 @@ class Evas.Box (Evas.Smart_Clipped)
on errors
@note Do @b not remove or delete objects while walking the list. */
return Eina.Iterator * @warn_unused;
return: Eina.Iterator * @warn_unused;
}
add_to {
/*@
@ -288,7 +288,7 @@ class Evas.Box (Evas.Smart_Clipped)
@see evas_object_box_add() */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
}
append {
/*@
@ -307,7 +307,7 @@ class Evas.Box (Evas.Smart_Clipped)
@note This call will trigger the box's _Evas_Object_Box_Api.append
smart function. */
return Evas_Object_Box_Option *;
return: Evas_Object_Box_Option *;
params {
@in Evas_Object *child @nonull; /*@ A child Evas object to be made a member of @p o */
}
@ -326,7 +326,7 @@ class Evas.Box (Evas.Smart_Clipped)
function. They'd have to implement it and set it to be the
_Evas_Object_Box_Api.property_id_get smart class function of the
box, which is originally set to @c NULL. */
return int @warn_unused;
return: int @warn_unused;
params {
@in const(char)* name @nonull; /*@ The name string of the option being searched, for
its ID */
@ -349,7 +349,7 @@ class Evas.Box (Evas.Smart_Clipped)
@note This call will trigger the box's
_Evas_Object_Box_Api.prepend smart function. */
return Evas_Object_Box_Option *;
return: Evas_Object_Box_Option *;
params {
@in Evas_Object *child @nonull; /*@ A child Evas object to be made a member of @p o */
}
@ -363,12 +363,12 @@ class Evas.Box (Evas.Smart_Clipped)
on errors
@note Do not remove or delete objects while walking the list. */
return Eina.Accessor * @warn_unused;
return: Eina.Accessor * @warn_unused;
}
internal_append {
/*@ No description supplied by the EAPI. */
legacy null;
return Evas_Object_Box_Option *;
legacy: null;
return: Evas_Object_Box_Option *;
params {
@in Evas_Object *child;
}
@ -384,7 +384,7 @@ class Evas.Box (Evas.Smart_Clipped)
evas_object_box_option_property_set(). See its documentation for
more details. */
return bool;
return: bool;
params {
@in Evas_Object_Box_Option *opt @nonull; /*@ The box option structure bound to the child box element
to set a property on */
@ -393,12 +393,12 @@ class Evas.Box (Evas.Smart_Clipped)
be set for this property. It @b must be of the same type the user has
defined for it. */
}
legacy null;
legacy: null;
}
internal_remove_at {
/*@ No description supplied by the EAPI. */
legacy null;
return Evas_Object *;
legacy: null;
return: Evas_Object *;
params {
@in uint pos;
}
@ -421,7 +421,7 @@ class Evas.Box (Evas.Smart_Clipped)
@note This call will trigger the box's
_Evas_Object_Box_Api.remove_at smart function. */
return bool;
return: bool;
params {
@in uint pos; /*@ The numeric position (starting from @c 0) of the child
object to be removed */
@ -437,7 +437,7 @@ class Evas.Box (Evas.Smart_Clipped)
This is a variable argument list variant of the
evas_object_box_option_property_get(). See its documentation for
more details. */
return bool;
return: bool;
params {
@in Evas_Object_Box_Option *opt @nonull; /*@ The box option structure bound to the child box element
to get a property from */
@ -446,12 +446,12 @@ class Evas.Box (Evas.Smart_Clipped)
store the values of this property. They @b must point to variables
of the same type the user has defined for them. */
}
legacy null;
legacy: null;
}
internal_insert_at {
/*@ No description supplied by the EAPI. */
legacy null;
return Evas_Object_Box_Option *;
legacy: null;
return: Evas_Object_Box_Option *;
params {
@in Evas_Object *child;
@in uint pos;
@ -476,7 +476,7 @@ class Evas.Box (Evas.Smart_Clipped)
@note This call will trigger the box's
_Evas_Object_Box_Api.insert_before smart function. */
return Evas_Object_Box_Option *;
return: Evas_Object_Box_Option *;
params {
@in Evas_Object *child @nonull; /*@ A child Evas object to be made a member of @p o */
@in const(Evas_Object)* reference @nonull; /*@ The child object to place this new one before */
@ -495,7 +495,7 @@ class Evas.Box (Evas.Smart_Clipped)
function. They'd have to implement it and set it to be the
_Evas_Object_Box_Api.property_name_get smart class function of the
box, which is originally set to @c NULL. */
return const(char)* @warn_unused;
return: const(char)* @warn_unused;
params {
@in int property; /*@ The numerical identifier of the option being searched,
for its name */
@ -503,8 +503,8 @@ class Evas.Box (Evas.Smart_Clipped)
}
internal_insert_before {
/*@ No description supplied by the EAPI. */
legacy null;
return Evas_Object_Box_Option *;
legacy: null;
return: Evas_Object_Box_Option *;
params {
@in Evas_Object *child;
@in const(Evas_Object)* reference;
@ -550,8 +550,8 @@ class Evas.Box (Evas.Smart_Clipped)
}
internal_option_new {
/*@ No description supplied by the EAPI. */
legacy null;
return Evas_Object_Box_Option*;
legacy: null;
return: Evas_Object_Box_Option*;
params {
@in Evas_Object *child;
}
@ -572,8 +572,8 @@ class Evas.Box (Evas.Smart_Clipped)
}
internal_insert_after {
/*@ No description supplied by the EAPI. */
legacy null;
return Evas_Object_Box_Option *;
legacy: null;
return: Evas_Object_Box_Option *;
params {
@in Evas_Object *child;
@in const(Evas_Object)* reference;
@ -598,7 +598,7 @@ class Evas.Box (Evas.Smart_Clipped)
@note This call will trigger the box's
_Evas_Object_Box_Api.insert_at smart function. */
return Evas_Object_Box_Option *;
return: Evas_Object_Box_Option *;
params {
@in Evas_Object *child @nonull; /*@ A child Evas object to be made a member of @p o */
@in uint pos; /*@ The numeric position (starting from @c 0) to place the
@ -607,8 +607,8 @@ class Evas.Box (Evas.Smart_Clipped)
}
internal_prepend {
/*@ No description supplied by the EAPI. */
legacy null;
return Evas_Object_Box_Option*;
legacy: null;
return: Evas_Object_Box_Option*;
params {
@in Evas_Object *child;
}
@ -628,7 +628,7 @@ class Evas.Box (Evas.Smart_Clipped)
@note This call will trigger the box's _Evas_Object_Box_Api.remove
smart function. */
return bool;
return: bool;
params {
@in Evas_Object *child @nonull; /*@ The handle to the child object to be removed */
}

64
src/lib/evas/canvas/evas_canvas.eo
View File

@ -245,7 +245,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@return @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise.
@ingroup Evas_Output_Method */
return bool;
return: bool;
}
get {
/*@
@ -302,7 +302,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
focused rectangle. See the full @ref Example_Evas_Events "example".
@ingroup Evas_Object_Group_Find */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
}
}
object_top {
@ -325,7 +325,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@warning This function will @b skip objects parented by smart
objects, acting only on the ones at the "top level", with regard to
object parenting. */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
}
}
key_lock {
@ -343,7 +343,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@return An .Evas_Lock handle to query Evas' keys subsystem with
evas_key_lock_is_set(), or @c NULL on error. */
return const(Evas_Lock)* @warn_unused;
return: const(Evas_Lock)* @warn_unused;
}
}
pointer_canvas_xy {
@ -380,7 +380,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@return The number of presses (0 if none active).
@since 1.2 */
return int;
return: int;
}
}
smart_objects_calculate_count {
@ -398,7 +398,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@ingroup Evas_Smart_Object_Group
@since 1.1 */
return int;
return: int;
}
}
focus_state {
@ -408,7 +408,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@return @c EINA_TRUE if it got the focus, @c EINA_FALSE otherwise.
@ingroup Evas_Canvas */
return bool;
return: bool;
}
}
changed {
@ -420,7 +420,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@ingroup Evas_Canvas
@since 1.11
*/
return bool;
return: bool;
}
}
pointer_output_xy {
@ -476,7 +476,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
if (evas_pointer_inside_get(evas)) printf("Mouse is in!\n");
else printf("Mouse is out!\n");
@endcode */
return bool @warn_unused;
return: bool @warn_unused;
}
}
image_max_size {
@ -491,7 +491,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
a limit, just a much higher one.
@since 1.1 */
return bool;
return: bool;
}
values {
int maxw; /*@ Pointer to hold the return value in pixels of the maximum width */
@ -517,7 +517,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@warning This function will @b skip objects parented by smart
objects, acting only on the ones at the "top level", with regard to
object parenting. */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
}
}
key_modifier {
@ -535,7 +535,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@return An .Evas_Modifier handle to query Evas' keys subsystem
with evas_key_modifier_is_set(), or @c NULL on error. */
return const(Evas_Modifier)* @warn_unused;
return: const(Evas_Modifier)* @warn_unused;
}
}
pointer_button_down_mask {
@ -575,7 +575,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
if ((button_mask & (1 << i)) != 0) printf("Button %i\n", i + 1);
}
@endcode */
return int @warn_unused;
return: int @warn_unused;
}
}
}
@ -591,7 +591,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
It will not append to the list pass events as hidden objects.
Call eina_list_free on the returned list after usage. */
return Eina.List * @warn_unused;
return: Eina.List * @warn_unused;
params {
@in Evas_Object *stop; /*@ An Evas Object where to stop searching. */
@in int x; /*@ The horizontal coordinate of the position. */
@ -667,7 +667,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@see evas_key_modifier_is_set
@see evas_object_key_grab
@see evas_object_key_ungrab */
return Evas_Modifier_Mask @warn_unused;
return: Evas_Modifier_Mask @warn_unused;
params {
@in const(char)* keyname @nonull; /*@ The name of the modifier key to create the mask for. */
}
@ -807,7 +807,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@warning This function will @b skip objects parented by smart
objects, acting only on the ones at the "top level", with regard to
object parenting. */
return Eina.List * @warn_unused;
return: Eina.List * @warn_unused;
params {
@in Evas_Coord x; /*@ The horizontal coordinate of the position */
@in Evas_Coord y; /*@ The vertical coordinate of the position */
@ -873,7 +873,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@ingroup Evas_Canvas
@since 1.8 */
return bool;
return: bool;
}
focus_out {
/*@
@ -939,7 +939,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@see evas_touch_point_list_nth_id_get()
@see evas_touch_point_list_nth_state_get() */
return uint;
return: uint;
}
event_input_multi_down {
/*@ No description supplied by the EAPI. */
@ -1010,7 +1010,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
#EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
@return @c EINA_TRUE if it is supported, @c EINA_FALSE otherwise.
@ingroup Evas_Font_Group */
return bool @warn_unused;
return: bool @warn_unused;
params {
@in Evas_Font_Hinting_Flags hinting; /*@ The hinting to use, one of #EVAS_FONT_HINTING_NONE, */
}
@ -1031,7 +1031,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@warning This function will @b skip objects parented by smart
objects, acting only on the ones at the "top level", with regard to
object parenting. */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
params {
@in Evas_Coord x; /*@ The horizontal coordinate of the position */
@in Evas_Coord y; /*@ The vertical coordinate of the position */
@ -1115,10 +1115,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
after you're done.
@ingroup Evas_Font_Group */
return Eina.List * @warn_unused;
return: Eina.List * @warn_unused;
}
objects_in_rectangle_get @const {
return Eina.List * @warn_unused;
return: Eina.List * @warn_unused;
params {
@in Evas_Coord x;
@in Evas_Coord y;
@ -1140,7 +1140,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
the object name is unique.
@ingroup Evas_Object_Group_Find */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
params {
@in const(char)* name; /*@ The given name. */
}
@ -1180,7 +1180,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@see evas_touch_point_list_nth_xy_get()
@see evas_touch_point_list_nth_state_get() */
return int;
return: int;
params {
@in uint n; /*@ The number of the touched point (0 being the first). */
}
@ -1271,7 +1271,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
Retrieves the list of font paths used by the given evas.
@return The list of font paths used.
@ingroup Evas_Font_Path_Group */
return const(Eina.List)* @warn_unused;
return: const(Eina.List)* @warn_unused;
}
image_cache_reload {
/*@
@ -1300,7 +1300,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
screen_x = evas_coord_world_x_to_screen(evas, canvas_x);
@endcode */
return int @warn_unused;
return: int @warn_unused;
params {
@in Evas_Coord x; /*@ The canvas x co-ordinate */
}
@ -1351,7 +1351,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@ingroup Evas_Canvas */
return Eina.List * @warn_unused;
return: Eina.List * @warn_unused;
}
image_cache_flush {
/*@
@ -1380,7 +1380,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
canvas_y = evas_coord_screen_y_to_world(evas, screen_y);
@endcode */
return Evas_Coord @warn_unused;
return: Evas_Coord @warn_unused;
params {
@in int y; /*@ The screen/output y co-ordinate */
}
@ -1428,7 +1428,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@see evas_touch_point_list_nth_xy_get()
@see evas_touch_point_list_nth_id_get() */
return Evas_Touch_Point_State;
return: Evas_Touch_Point_State;
params {
@in uint n; /*@ The number of the touched point (0 being the first). */
}
@ -1542,7 +1542,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@warning This function will @b skip objects parented by smart
objects, acting only on the ones at the "top level", with regard to
object parenting. */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
params {
@in Evas_Coord x; /*@ The top left corner's horizontal coordinate for the
rectangular region */
@ -1645,7 +1645,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
canvas_x = evas_coord_screen_x_to_world(evas, screen_x);
@endcode */
return Evas_Coord @warn_unused;
return: Evas_Coord @warn_unused;
params {
@in int x; /*@ The screen/output x co-ordinate */
}
@ -1712,7 +1712,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
screen_y = evas_coord_world_y_to_screen(evas, canvas_y);
@endcode */
return int @warn_unused;
return: int @warn_unused;
params {
@in Evas_Coord y; /*@ The canvas y co-ordinate */
}

2
src/lib/evas/canvas/evas_common_interface.eo
View File

@ -5,7 +5,7 @@ interface Evas.Common_Interface ()
evas {
get {
/*@ No description supplied by the EAPI. */
legacy evas_object_evas_get;
legacy: evas_object_evas_get;
}
values {
Evas *ret;

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

@ -53,7 +53,7 @@ class Evas.Grid (Evas.Smart_Clipped)
It's possible to remove objects from the grid when walking this
list, but these removals won't be reflected on it.
@since 1.1 */
return Eina.List * @warn_unused;
return: Eina.List * @warn_unused;
}
}
}
@ -64,7 +64,7 @@ class Evas.Grid (Evas.Smart_Clipped)
@note Do not remove or delete objects while walking the list.
@since 1.1 */
return Eina.Accessor * @warn_unused;
return: Eina.Accessor * @warn_unused;
}
clear {
/*@
@ -82,7 +82,7 @@ class Evas.Grid (Evas.Smart_Clipped)
@note Do not remove or delete objects while walking the list.
@since 1.1 */
return Eina.Iterator * @warn_unused;
return: Eina.Iterator * @warn_unused;
}
add_to {
/*@
@ -91,7 +91,7 @@ class Evas.Grid (Evas.Smart_Clipped)
@see evas_object_grid_add()
@since 1.1 */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
}
unpack {
/*@
@ -104,7 +104,7 @@ class Evas.Grid (Evas.Smart_Clipped)
@return 1 on success, 0 on failure.
@since 1.1 */
return bool;
return: bool;
params {
@in Evas_Object *child @nonull;
}
@ -117,7 +117,7 @@ class Evas.Grid (Evas.Smart_Clipped)
evas_object_grid_pack()
@return 1 on success, 0 on failure.
@since 1.1 */
return bool;
return: bool;
params {
@in Evas_Object *child; /*@ The grid child to query for coordinates */
@out int x; /*@ The pointer to where the x coordinate will be returned */
@ -133,7 +133,7 @@ class Evas.Grid (Evas.Smart_Clipped)
@return 1 on success, 0 on failure.
@since 1.1 */
return bool;
return: bool;
params {
@in Evas_Object *child @nonull; /*@ The child object to add. */
@in int x; /*@ The virtual x coordinate of the child */

44
src/lib/evas/canvas/evas_image.eo
View File

@ -76,7 +76,7 @@ class Evas.Image (Evas.Object)
@see evas_object_image_source_get()
@see evas_object_image_source_unset()
@see evas_object_image_source_visible_set() */
return bool;
return: bool;
}
get {
/*@
@ -631,7 +631,7 @@ class Evas.Image (Evas.Object)
This function sets a native surface of a given canvas image. */
legacy null;
legacy: null;
}
get {
/*@
@ -847,7 +847,7 @@ class Evas.Image (Evas.Object)
@since 1.2
This function returns the state of the region support of given image */
return bool @warn_unused;
return: bool @warn_unused;
}
}
load_error {
@ -859,7 +859,7 @@ class Evas.Image (Evas.Object)
@return A value giving the last error that occurred. It should be
one of the #Evas_Load_Error values. #EVAS_LOAD_ERROR_NONE
is returned if there was no error. */
return Evas_Load_Error @warn_unused;
return: Evas_Load_Error @warn_unused;
}
}
animated_frame_count {
@ -878,7 +878,7 @@ class Evas.Image (Evas.Object)
@see evas_object_image_animated_frame_duration_get()
@see evas_object_image_animated_frame_set()
@since 1.1 */
return int;
return: int;
}
}
stride {
@ -890,7 +890,7 @@ class Evas.Image (Evas.Object)
The row stride is the number of bytes between the start of a row
and the start of the next row for image data. */
return int @warn_unused;
return: int @warn_unused;
}
}
animated {
@ -944,7 +944,7 @@ class Evas.Image (Evas.Object)
@see evas_object_image_animated_frame_duration_get()
@see evas_object_image_animated_frame_set()
@since 1.1 */
return bool;
return: bool;
}
}
animated_loop_type {
@ -970,7 +970,7 @@ class Evas.Image (Evas.Object)
@see evas_object_image_animated_frame_duration_get()
@see evas_object_image_animated_frame_set()
@since 1.1 */
return Evas_Image_Animated_Loop_Hint;
return: Evas_Image_Animated_Loop_Hint;
}
}
animated_loop_count {
@ -994,7 +994,7 @@ class Evas.Image (Evas.Object)
@see evas_object_image_animated_frame_duration_get()
@see evas_object_image_animated_frame_set()
@since 1.1 */
return int;
return: int;
}
}
@ -1007,7 +1007,7 @@ class Evas.Image (Evas.Object)
@see evas_object_image_scene_set
@since 1.10 */
legacy null;
legacy: null;
}
get {
/*@
@ -1019,7 +1019,7 @@ class Evas.Image (Evas.Object)
@see evas_object_image_scene_get
@since 1.10 */
legacy null;
legacy: null;
}
values {
Evas_3D_Scene *scene; /*@ 3D scene on an image object. */
@ -1039,7 +1039,7 @@ class Evas.Image (Evas.Object)
please use only for testing purposes.
@see @ref evasfiltersref "Evas filters reference"
*/
legacy null;
legacy: null;
}
values {
const(char)* program; /*@ The program code, as defined
@ -1060,7 +1060,7 @@ class Evas.Image (Evas.Object)
This will create automatically a new RGBA buffer containing
the source object's pixels (as it is rendered). */
legacy null;
legacy: null;
}
values {
const(char)* name; /*@ Object name as used in the program code */
@ -1070,8 +1070,8 @@ class Evas.Image (Evas.Object)
filter_padding {
get {
/*@ Get the value of the extra padding set when a filter is used. */
return bool; /*@ Returns false if the filter is invalid and padding is 0 */
legacy null;
return: bool; /*@ Returns false if the filter is invalid and padding is 0 */
legacy: null;
}
values {
int l; /*@ Left padding in pixels */
@ -1084,7 +1084,7 @@ class Evas.Image (Evas.Object)
methods {
preload_begin {
/*@ Begin preloading an image object's image data in the background */
legacy null;
legacy: null;
}
data_update_add {
/*@
@ -1118,7 +1118,7 @@ class Evas.Image (Evas.Object)
@see evas_object_image_animated_frame_duration_get()
@see evas_object_image_animated_frame_set()
@since 1.1 */
return double;
return: double;
params {
@in int start_frame; /*@ The first frame */
@in int frame_num; /*@ Number of frames in the sequence */
@ -1136,7 +1136,7 @@ class Evas.Image (Evas.Object)
You can specify some flags when saving the image. Currently
acceptable flags are @c quality and @c compress. Eg.: @c
"quality=100 compress=9" */
return bool;
return: bool;
params {
@in const(char)* file @nonull; /*@ The filename to be used to save the image (extension
obligatory). */
@ -1189,7 +1189,7 @@ class Evas.Image (Evas.Object)
inform data changes, if you did any.
@see evas_object_image_data_set() */
return void * @warn_unused;
return: void * @warn_unused;
params {
@in bool for_writing; /*@ Whether the data being retrieved will be
modified (@c EINA_TRUE) or not (@c EINA_FALSE). */
@ -1197,7 +1197,7 @@ class Evas.Image (Evas.Object)
}
preload_cancel {
/*@ Cancel preloading an image object's image data in the background */
legacy null;
legacy: null;
}
data_convert {
/*@
@ -1214,7 +1214,7 @@ class Evas.Image (Evas.Object)
@return data A newly allocated data in the format specified by to_cspace. */
return void * @warn_unused;
return: void * @warn_unused;
params {
@in Evas_Colorspace to_cspace; /*@ The colorspace to which the image raw data will be converted. */
}
@ -1225,7 +1225,7 @@ class Evas.Image (Evas.Object)
This function imports pixels from a given source to a given canvas image. */
return bool;
return: bool;
params {
@in Evas_Pixel_Import_Source *pixels @nonull; /*@ The pixel's source to be imported. */
}

36
src/lib/evas/canvas/evas_object.eo
View File

@ -77,11 +77,11 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
visibility {
set {
/*@ Makes the given Evas object visible or invisible. */
legacy null;
legacy: null;
}
get {
/*@ Retrieves whether or not the given Evas object is visible. */
legacy evas_object_visible_get;
legacy: evas_object_visible_get;
}
values {
bool v; /*@ @c EINA_TRUE if to make the object visible, @c EINA_FALSE otherwise */
@ -90,7 +90,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
type {
set {
/*@ Sets the type of the given Evas object. */
legacy null;
legacy: null;
}
get {
/*@
@ -733,11 +733,11 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
size {
set {
/*@ Changes the size of the given Evas object. */
legacy evas_object_resize;
legacy: evas_object_resize;
}
get {
/*@ Retrieves the (rectangular) size of the given Evas object. */
legacy null;
legacy: null;
}
values {
Evas_Coord w; /*@ in */
@ -1019,11 +1019,11 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
position {
set {
/*@ Move the given Evas object to the given location inside its canvas' viewport. */
legacy evas_object_move;
legacy: evas_object_move;
}
get {
/*@ Retrieves the position of the given Evas object. */
legacy null;
legacy: null;
}
values {
Evas_Coord x; /*@ in */
@ -1107,7 +1107,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
@see evas_object_smart_data_set()
@ingroup Evas_Smart_Object_Group */
return void * @warn_unused;
return: void * @warn_unused;
}
}
smart_clipped_clipper {
@ -1121,7 +1121,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
properties, like colors.
@see evas_object_smart_clipped_smart_add() */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
}
}
below {
@ -1138,7 +1138,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
@see evas_object_layer_get()
@see evas_object_layer_set()
@see evas_object_below_get() */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
}
}
clipees {
@ -1180,7 +1180,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
evas_object_show(obj_tmp);
}
@endcode */
return const(Eina.List)* @warn_unused;
return: const(Eina.List)* @warn_unused;
}
}
smart_parent {
@ -1192,7 +1192,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
obj is not a smart member of any
@ingroup Evas_Smart_Object_Group */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
}
}
above {
@ -1209,7 +1209,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
@see evas_object_layer_get()
@see evas_object_layer_set()
@see evas_object_below_get() */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
}
}
size_hint_display_mode {
@ -1241,7 +1241,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
@return EINA_TRUE if @p obj clip any object.
@since 1.8 */
return bool @warn_unused;
return: bool @warn_unused;
}
key_grab {
/*@
@ -1284,7 +1284,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
@see evas_focus_get
@see evas_key_modifier_add */
return bool @warn_unused;
return: bool @warn_unused;
params {
@in const(char)* keyname @nonull; /*@ the key to request events for. */
@in Evas_Modifier_Mask modifiers; /*@ a mask of modifiers that must be present to
@ -1387,7 +1387,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
@see eo_isa
@ingroup Evas_Smart_Object_Group */
return bool @warn_unused;
return: bool @warn_unused;
params {
@in const(char)* type @nonull; /*@ The @b name (type) of the smart class to check for */
}
@ -1408,7 +1408,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
@since 1.2
@ingroup Evas_Object_Group_Find */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
params {
@in const(char)* name; /*@ The given name. */
@in int recurse; /*@ Set to the number of child levels to recurse (0 == don't recurse, 1 == only look at the children of @p obj or their immediate children, but no further etc.). */
@ -1496,7 +1496,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface)
@see eo_isa
@ingroup Evas_Smart_Object_Group */
return bool @warn_unused;
return: bool @warn_unused;
params {
@in const(char)* type @nonull; /*@ The type (name string) to check for. Must be the name */
}

32
src/lib/evas/canvas/evas_object_smart.eo
View File

@ -52,7 +52,7 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
clip {
set {
/*@ No description supplied by the EAPI. */
legacy null;
legacy: null;
}
values {
Evas_Object *clip;
@ -61,7 +61,7 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
color {
set {
/*@ No description supplied by the EAPI. */
legacy null;
legacy: null;
}
values {
int r;
@ -102,7 +102,7 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
@see evas_object_smart_member_add()
@see evas_object_smart_member_del()
@see evas_object_smart_iterator_new() */
return Eina.List * @warn_unused;
return: Eina.List * @warn_unused;
}
}
smart {
@ -113,18 +113,18 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
@return the #Evas_Smart handle or @c NULL, on errors
@ingroup Evas_Smart_Object_Group */
return Evas_Smart * @warn_unused;
return: Evas_Smart * @warn_unused;
}
}
}
methods {
show {
/*@ No description supplied by the EAPI. */
legacy null;
legacy: null;
}
move {
/*@ No description supplied by the EAPI. */
legacy null;
legacy: null;
params {
@in Evas_Coord x;
@in Evas_Coord y;
@ -157,7 +157,7 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
@ingroup Evas_Smart_Object_Group */
return bool;
return: bool;
params {
@in const(Evas_Smart_Cb_Description)* descriptions; /*@ @c NULL terminated array with
#Evas_Smart_Cb_Description descriptions. Array elements won't be
@ -212,7 +212,7 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
@see evas_object_smart_member_add()
@see evas_object_smart_member_del()
@see evas_object_smart_members_get() */
return Eina.Iterator * @warn_unused;
return: Eina.Iterator * @warn_unused;
}
callback_description_find @const {
/*@
@ -234,7 +234,7 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
}
hide {
/*@ No description supplied by the EAPI. */
legacy null;
legacy: null;
}
calculate {
/*@
@ -264,7 +264,7 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
#EVAS_SMART_SUBCLASS_NEW, for example.
@ingroup Evas_Smart_Object_Group */
legacy null;
legacy: null;
}
member_add {
/*@
@ -287,11 +287,11 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
params {
@in Evas_Object *sub_obj @nonull; /*@ The member object */
}
legacy null;
legacy: null;
}
resize {
/*@ No description supplied by the EAPI. */
legacy null;
legacy: null;
params {
@in Evas_Coord w;
@in Evas_Coord h;
@ -299,7 +299,7 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
}
clip_unset {
/*@ No description supplied by the EAPI. */
legacy null;
legacy: null;
}
changed {
/*@
@ -330,18 +330,18 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface)
@in Evas_Object *sub_obj; /*@ the member object
@ingroup Evas_Smart_Object_Group */
}
legacy null;
legacy: null;
}
del {
/*@ Deletes a smart object. */
legacy null;
legacy: null;
}
attach {
/*@ Attach a given smart data to a given smart object. */
params {
@in Evas_Smart *s;
}
legacy null;
legacy: null;
}
}
implements {

2
src/lib/evas/canvas/evas_out.eo
View File

@ -20,7 +20,7 @@ class Evas.Out (Eo.Base)
engine_info {
set {
/*@ Sets the engine specific output parameters for a given output. */
return bool;
return: bool;
}
get {
/*@ Gets the engine specific output parameters for a given output. */

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

@ -130,7 +130,7 @@ class Evas.Table (Evas.Smart_Clipped)
It's up to the user to destroy it when it no longer needs it.
It's possible to remove objects from the table when walking this
list, but these removals won't be reflected on it. */
return Eina.List * @warn_unused;
return: Eina.List * @warn_unused;
}
}
child {
@ -163,14 +163,14 @@ class Evas.Table (Evas.Smart_Clipped)
Get an accessor to get random access to the list of children for the table.
@note Do not remove or delete objects while walking the list. */
return Eina.Accessor * @warn_unused;
return: Eina.Accessor * @warn_unused;
}
iterator_new @const {
/*@
Get an iterator to walk the list of children for the table.
@note Do not remove or delete objects while walking the list. */
return Eina.Iterator * @warn_unused;
return: Eina.Iterator * @warn_unused;
}
add_to {
/*@
@ -178,7 +178,7 @@ class Evas.Table (Evas.Smart_Clipped)
@see evas_object_table_add() */
return Evas_Object * @warn_unused;
return: Evas_Object * @warn_unused;
}
pack_get @const {
/*@
@ -186,7 +186,7 @@ class Evas.Table (Evas.Smart_Clipped)
@return 1 on success, 0 on failure.
@since 1.1 */
return bool;
return: bool;
params {
@in Evas_Object *child; /*@ The child object to add. */
@out ushort col; /*@ pointer to store relative-horizontal position to place child. */
@ -207,7 +207,7 @@ class Evas.Table (Evas.Smart_Clipped)
@return 1 on success, 0 on failure. */
return bool;
return: bool;
params {
@in Evas_Object *child @nonull; /*@ The child object to add. */
@in ushort col; /*@ relative-horizontal position to place child. */
@ -226,7 +226,7 @@ class Evas.Table (Evas.Smart_Clipped)
@return 1 on success, 0 on failure. */
return bool;
return: bool;
params {
@in Evas_Object *child @nonull;
}

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

@ -309,7 +309,7 @@ class Evas.Text (Evas.Object)
please use only for testing purposes.
@see @ref evasfiltersref "Evas filters reference"
*/
legacy null;
legacy: null;
}
values {
const(char)* program; /*@ The program code, as defined
@ -329,7 +329,7 @@ class Evas.Text (Evas.Object)
@note EXPERIMENTAL FEATURE. This is an unstable API,
please use only for testing purposes.
@see @ref evasfiltersref "Evas filters reference" */
legacy null;
legacy: null;
}
values {
const(char)* name; /*@ Object name as used in the program code */
@ -338,7 +338,7 @@ class Evas.Text (Evas.Object)
}
max_descent {
get {
return Evas_Coord;
return: Evas_Coord;
}
}
style_pad {
@ -359,51 +359,51 @@ class Evas.Text (Evas.Object)
Retrieves the direction of the text currently being displayed in the
text object.
@return the direction of the text */
return Evas_BiDi_Direction;
return: Evas_BiDi_Direction;
}
}
ascent {
get {
return Evas_Coord;
return: Evas_Coord;
}
}
horiz_advance {
get {
return Evas_Coord;
return: Evas_Coord;
}
}
inset {
get {
return Evas_Coord;
return: Evas_Coord;
}
}
max_ascent {
get {
return Evas_Coord;
return: Evas_Coord;
}
}
vert_advance {
get {
return Evas_Coord;
return: Evas_Coord;
}
}
descent {
get {
return Evas_Coord;
return: Evas_Coord;
}
}
}
methods {
last_up_to_pos @const {
/*@ Returns the logical position of the last char in the text up to the pos given. this is NOT the position of the last char because of the possibility of RTL in the text. */
return int;
return: int;
params {
@in Evas_Coord x; /*@ in */
@in Evas_Coord y; /*@ in */
}
}
char_coords_get @const {
return int;
return: int;
params {
@in Evas_Coord x; /*@ in */
@in Evas_Coord y; /*@ in */
@ -424,7 +424,7 @@ class Evas.Text (Evas.Object)
parameter.
@return @c EINA_FALSE on success, @c EINA_TRUE on error. */
return bool;
return: bool;
params {
@in int pos; /*@ The character position to request co-ordinates for. */
@out Evas_Coord cx; /*@ A pointer to an @c Evas_Coord to store the X value in (can be NULL). */

22
src/lib/evas/canvas/evas_textblock.eo
View File

@ -119,7 +119,7 @@ class Evas.Textblock (Evas.Object)
node_format_first {
get {
/*@ Returns the first format node. */
legacy evas_textblock_node_format_first_get;
legacy: evas_textblock_node_format_first_get;
}
values {
const(Evas_Object_Textblock_Node_Format)* format;
@ -153,7 +153,7 @@ class Evas.Textblock (Evas.Object)
node_format_last {
get {
/*@ Returns the last format node. */
legacy evas_textblock_node_format_last_get;
legacy: evas_textblock_node_format_last_get;
}
values {
const(Evas_Object_Textblock_Node_Format)* format;
@ -165,7 +165,7 @@ class Evas.Textblock (Evas.Object)
Return the object's main cursor.
@return The @p obj's main cursor. */
return Evas_Textblock_Cursor *;
return: Evas_Textblock_Cursor *;
}
}
size_native {
@ -209,7 +209,7 @@ class Evas.Textblock (Evas.Object)
Get the geometry of a line number.
@return @c EINA_TRUE on success, @c EINA_FALSE otherwise. */
return bool;
return: bool;
params {
@in int line; /*@ the line number. */
@out Evas_Coord cx; /*@ x coord of the line. */
@ -225,7 +225,7 @@ class Evas.Textblock (Evas.Object)
@return Replacement character or @c NULL. */
return const(char)*;
return: const(char)*;
}
style_user_pop {
/*@
@ -244,12 +244,12 @@ class Evas.Textblock (Evas.Object)
@note if you need speed and you know what you are doing, it's slightly faster to just allocate the cursor yourself and not associate it. (only people developing the actual object, and not users of the object).
@return the new cursor. */
return Evas_Textblock_Cursor *;
return: Evas_Textblock_Cursor *;
}
node_format_list_get @const {
/*@ No description supplied by the EAPI. */
legacy evas_textblock_node_format_list_get;
return const(Eina.List)*;
legacy: evas_textblock_node_format_list_get;
return: const(Eina.List)*;
params {
@in const(char)* anchor;
}
@ -261,11 +261,11 @@ class Evas.Textblock (Evas.Object)
@return the style of the object.
@see evas_object_textblock_style_get
@since 1.2 */
return const(Evas_Textblock_Style)*;
return: const(Evas_Textblock_Style)*;
}
node_format_remove_pair {
/*@ Remove a format node and its match. */
legacy evas_textblock_node_format_remove_pair;
legacy: evas_textblock_node_format_remove_pair;
params {
@in Evas_Object_Textblock_Node_Format *n;
}
@ -277,7 +277,7 @@ class Evas.Textblock (Evas.Object)
@return nothing. */
legacy null;
legacy: null;
}
style_user_push {
/*@

2
src/lib/evas/canvas/evas_textgrid.eo
View File

@ -213,7 +213,7 @@ class Evas.Textgrid (Evas.Object)
@see evas_object_textgrid_update_add()
@since 1.7 */
return Evas_Textgrid_Cell*;
return: Evas_Textgrid_Cell*;
params {
@in int y; /*@ The row index of the grid. */
}

4
src/tests/eolian/data/class_simple.eo
View File

@ -8,7 +8,7 @@ class Class_Simple {
set {
/*@
comment a.set */
return bool (true); /*@ comment for property set return */
return: bool (true); /*@ comment for property set return */
}
get {
}
@ -25,7 +25,7 @@ class Class_Simple {
@inout char b;
@out double c;
}
return char * (null); /*@ comment for method return */
return: char * (null); /*@ comment for method return */
}
}
}

4
src/tests/eolian/data/complex_type.eo
View File

@ -2,7 +2,7 @@ class Complex_Type {
properties {
a {
set {
return own(Eina.List*)<Eina.Array*<own(Eo**)>>;
return: own(Eina.List*)<Eina.Array*<own(Eo**)>>;
}
get {
}
@ -16,7 +16,7 @@ class Complex_Type {
params {
own(char*) buf;
}
return own(Eina.List*)<Eina.Stringshare *>; /*@ comment for method return */
return: own(Eina.List*)<Eina.Stringshare *>; /*@ comment for method return */
}
}
}

4
src/tests/eolian/data/consts.eo
View File

@ -2,7 +2,7 @@ class Consts {
properties {
a {
set {
return bool (true); /*@ comment for property set return */
return: bool (true); /*@ comment for property set return */
}
get {
buffer: const;
@ -21,7 +21,7 @@ class Consts {
@inout char b;
@out double c;
}
return char * (null); /*@ comment for method return */
return: char * (null); /*@ comment for method return */
}
}
}

2
src/tests/eolian/data/extern.eo
View File

@ -22,7 +22,7 @@ class Extern {
params {
int idx;
}
return own(char*);
return: own(char*);
}
}
}

4
src/tests/eolian/data/object_impl.eo
View File

@ -12,7 +12,7 @@ class Object_Impl (Base) {
properties {
a {
set {
return bool (false);
return: bool (false);
value: const;
}
get {
@ -43,7 +43,7 @@ class Object_Impl (Base) {
@inout char b;
@out double c;
}
return char * (null); /*@ comment for method return */
return: char * (null); /*@ comment for method return */
}
foo2 @const {
/*@ comment foo */

2
src/tests/eolian/data/struct.eo
View File

@ -25,7 +25,7 @@ class Struct {
params {
int idx;
}
return own(char*);
return: own(char*);
}
}
}

2
src/tests/eolian/data/typedef.eo
View File

@ -7,7 +7,7 @@ class Typedef {
params {
int idx;
}
return own(char*); /*@ comment for method return */
return: own(char*); /*@ comment for method return */
}
}
}