eo: fix up the remaining doc comments

This commit is contained in:
Daniel Kolesa 2015-05-11 15:25:29 +01:00
parent e74cd43c7b
commit 5fdf454ef0
12 changed files with 28 additions and 28 deletions

View File

@ -39,7 +39,7 @@ class Elm_App_Client (Eo.Base)
@in Elm_App_Client_Open_View_Cb view_open_cb @optional; /*@ callback to be called when view open */
@in const(void)* data @optional; /*@ calback user data */
}
return: Elm_App_Client_Pending *; /* handler to cancel the view opening if it takes to long */
return: Elm_App_Client_Pending *; /*@ handler to cancel the view opening if it takes to long */
}
view_open_cancel {
/*@ Cancel a pending elm_app_client_view_open(). */

View File

@ -64,7 +64,7 @@ class Elm_App_Server (Eo.Base)
params {
@in const(char)* id; /*@ view identifier */
}
return: bool; /* @c EINA_TRUE if id is valid or @c EINA_FALSE if not */
return: bool; /*@ @c EINA_TRUE if id is valid or @c EINA_FALSE if not */
}
view_add {
/*@ Add a view to elm_app_server. This should only be used if the application open a view that was not requested by create_view_cb. */
@ -80,7 +80,7 @@ class Elm_App_Server (Eo.Base)
}
title_get {
/*@ Get title of application */
return: Eina_Stringshare *; /* title of application */
return: Eina_Stringshare *; /*@ title of application */
}
save {
/*@ Save the state of all views */

View File

@ -20,7 +20,7 @@ mixin Elm_Interface_Atspi_Image ()
}
@property description @protected {
get {
/* Gets textual description of image */
/*@ Gets textual description of image */
}
set {
}
@ -30,7 +30,7 @@ mixin Elm_Interface_Atspi_Image ()
}
@property locale @protected {
get {
/* Gets locale of the image description. */
/*@ Gets locale of the image description. */
}
values {
const(char)* locale;

View File

@ -5,12 +5,12 @@ interface Elm_Interface_Atspi_Selection ()
methods {
@property selected_children_count @protected {
get {
/* Gets the number of currently selected children */
/*@ Gets the number of currently selected children */
return: int;
}
}
@property selected_child @protected {
/* Gets child for given child index */
/*@ Gets child for given child index */
get {
return: Eo *;
}
@ -19,36 +19,36 @@ interface Elm_Interface_Atspi_Selection ()
}
}
child_select @protected {
/* Adds selection for given child index */
/*@ Adds selection for given child index */
params {
@in int child_index;
}
return: bool;
}
selected_child_deselect @protected {
/* Removes selection for given child index */
/*@ Removes selection for given child index */
params {
@in int child_index;
}
return: bool;
}
is_child_selected @protected {
/* Determines if child specified by index is selected */
/*@ Determines if child specified by index is selected */
params {
@in int child_index;
}
return: bool;
}
all_children_select @protected {
/* Adds selection for all children */
/*@ Adds selection for all children */
return: bool;
}
clear @protected {
/* Clears the current selection */
/*@ Clears the current selection */
return: bool;
}
child_deselect @protected {
/* Removes selection for given child index */
/*@ Removes selection for given child index */
params {
@in int child_index;
}

View File

@ -73,12 +73,12 @@ interface Elm_Interface_Atspi_Text ()
is set. */
}
values {
own(char *) value; /* Value of text attribute. Should be free() */
own(char *) value; /*@ Value of text attribute. Should be free() */
}
}
@property attributes @protected {
get {
/* Gets list of all text attributes. */
/*@ Gets list of all text attributes. */
}
keys {
int *start_offset @nonull;

View File

@ -19,7 +19,7 @@ interface Elm_Interface_Atspi_Value ()
}
@property range @protected {
get {
/* Gets a range of all possible values and its description */
/*@ Gets a range of all possible values and its description */
}
values {
double lower_limit;
@ -29,7 +29,7 @@ interface Elm_Interface_Atspi_Value ()
}
@property increment @protected {
get {
/* Gets an minimal incrementation value */
/*@ Gets an minimal incrementation value */
}
values {
double increment;

View File

@ -5,8 +5,8 @@ interface Elm_Interface_Atspi_Window ()
window,destroyed; /*@ Called when window has been destroyed. */
window,activated; /*@ Called when window has been activated. (unfocused) */
window,deactivated; /*@ Called when window has been deactivated (unfocused). */
window,maximized; /* @ Called when window has been maximmized */
window,minimized; /* @ Called when window has been minimized */
window,restored; /* @ Called when window has been restored */
window,maximized; /*@ Called when window has been maximmized */
window,minimized; /*@ Called when window has been minimized */
window,restored; /*@ Called when window has been restored */
}
}

View File

@ -47,7 +47,7 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart)
}
}
@property bounce_allow {
/* @brief Bouncing behavior
/*@ @brief Bouncing behavior
*
* When scrolling, the scroller may "bounce" when reaching an edge of the
* content object. This is a visual way to indicate the end has been reached.
@ -67,7 +67,7 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart)
}
@property wheel_disabled {
set {
/* @brief Set Wheel disable
/*@ @brief Set Wheel disable
* Enable or disable mouse wheel to be used to scroll the scroller content.
* Wheel is enabled by default.
*
@ -75,7 +75,7 @@ mixin Elm_Interface_Scrollable(Evas.Scrollable_Interface, Evas.Object_Smart)
*/
}
get {
/* @brief Get Wheel disable
/*@ @brief Get Wheel disable
* Get a value whether wheel to be used to scroll the scroller content.
*
* @ingroup Widget

View File

@ -31,7 +31,7 @@ class Elm.List_Item(Elm.Widget_Item)
}
@property selected {
get {
/*
/*@
Get whether the @p item is selected or not.
@see elm_list_selected_item_set() for details.

View File

@ -48,7 +48,7 @@ class Elm.Segment_Control_Item(Elm.Widget_Item)
@ingroup SegmentControl
*/
params {
Eina_Bool selected; /* @ The selected state. */
Eina_Bool selected; /*@ The selected state. */
}
}
}

View File

@ -22,7 +22,7 @@ class Elm.Thumb (Elm.Layout, Efl.File, Evas.Clickable_Interface)
@see elm_thumb_compress_set()
@ingroup Thumb */
return: void; /* Force the return type to be sure the argument doesn't become the return */
return: void; /*@ Force the return type to be sure the argument doesn't become the return */
}
values {
int compress; /*@ The compression of the thumb. */
@ -204,7 +204,7 @@ class Elm.Thumb (Elm.Layout, Efl.File, Evas.Clickable_Interface)
@see elm_thumb_quality_set()
@ingroup Thumb */
return: void; /* Force the return type to be sure the argument doesn't become the return */
return: void; /*@ Force the return type to be sure the argument doesn't become the return */
}
values {
int quality; /*@ The quality of the thumb. */

View File

@ -61,7 +61,7 @@ class Elm.Toolbar_Item(Elm.Widget_Item)
*/
}
values {
int priority; /* The @p item priority. The default is zero for set and 0 is returned on failure. */
int priority; /*@ The @p item priority. The default is zero for set and 0 is returned on failure. */
}
}
@property selected {