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

eo-docs: Remove Doxygen tags from efl*.eo files 

Summary:
- Replace '\@ref name' with '@name'
- Remove unused \@internal tag
    This tag affects text AFTER it, and there is no text after it.
- Remove \@note tag
    Replaced with a simple NOTE: text, since eolian does not have an equivalent tag.
- Remove spurious \@Efl... tags
    They should really be @Efl...
- Remove \@p tags
    There is no eolian equivalent, and a simpler $ suffices in this case.

Fixes T7482

Reviewers: q66

Reviewed By: q66

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Maniphest Tasks: T7482

Differential Revision: https://phab.enlightenment.org/D7372
This commit is contained in:
Xavi Artigas 2018-11-28 13:33:46 +01:00 committed by Daniel Kolesa
parent c602c075ca
commit 05682eed7d
25 changed files with 50 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -221,7 +221,7 @@ class Efl.Io.Buffered_Stream (Efl.Loop_Consumer, Efl.Io.Reader, Efl.Io.Writer, E
is closed or the wrapper itself's closed, this
function will do nothing and return $true.
\@note this function may block the main loop execution
Note: this function may block the main loop execution
until operations are complete! This is bad for usability as
the user interface or other operations may freeze. A better
approach is to operate asynchronously and wait for the

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

@ -346,7 +346,7 @@ class Efl.Io.Copier (Efl.Loop_Consumer, Efl.Io.Closer) {
This function may also emit "progress" and "error"
events.
\@note this function may block the main loop execution
Note: this function may block the main loop execution
until operations are complete! This is bad for usability as
user interface or other operations may freeze. A better
approach is to operate asynchronously and wait for the

4
src/lib/ecore_con/efl_net_control_access_point.eo
View File

@ -81,7 +81,7 @@ class Efl.Net.Control.Access_Point (Efl.Loop_Consumer) {
create access points to allow configuration and connection.
An application requiring only a network connection can just
use a \@Efl.Net.Session instead.
use a @Efl.Net.Session instead.
@since 1.19
]]
@ -177,7 +177,7 @@ class Efl.Net.Control.Access_Point (Efl.Loop_Consumer) {
first (most priority), then use 0. To move as the last
priority, use UINT32_MAX or the last known priority + 1.
\@note Only stored access points may be reordered
Note: Only stored access points may be reordered
among themselves. Those that are not remembered will
always come last in a random order defined by the backend.
]]

4
src/lib/ecore_con/efl_net_control_manager.eo
View File

@ -71,7 +71,7 @@ class Efl.Net.Control.Manager (Efl.Loop_Consumer) {
This class and its child objects are only useful to implement
control of the network connectivity. If your application only
needs to request access to the network, use
\@Efl.Net.Session instead.
@Efl.Net.Session instead.
Network connectivity is defined on top of technologies that
provide access points. A technology can be "ethernet", "wifi",
@ -142,7 +142,7 @@ class Efl.Net.Control.Manager (Efl.Loop_Consumer) {
- online means verified connectivity.
\@note if there is no backend for this class, then state
Note: if there is no backend for this class, then state
will always be online, however @.access_points and
@.technologies will be empty iterators (valid pointers
but no items in them).

2
src/lib/ecore_con/efl_net_dialer_http.eo
View File

@ -323,7 +323,7 @@ class Efl.Net.Dialer_Http (Efl.Loop_Consumer, Efl.Net.Dialer, Efl.Io.Sizer) {
system, create a cookie jar and pass its path to this
property.
\@note that whenever this property is set, even if to the
Note: that whenever this property is set, even if to the
same value, it will flush all cookies to the previously
set file, then erase all known cookies. It will then use the new
file (if any).

2
src/lib/ecore_con/efl_net_dialer_unix.eo
View File

@ -4,7 +4,7 @@ class Efl.Net.Dialer_Unix (Efl.Net.Socket_Unix, Efl.Net.Dialer) {
The dial address is a file system path (portable) or
"abstract:ID" (Linux-only extension).
\@note Proxies are meaningless for AF_UNIX family, thus are not
Note: Proxies are meaningless for AF_UNIX family, thus are not
implemented.
@since 1.19

2
src/lib/ecore_con/efl_net_dialer_websocket.eo
View File

@ -292,7 +292,7 @@ class Efl.Net.Dialer_Websocket (Efl.Loop_Consumer, Efl.Net.Dialer) {
system, create a cookie jar and pass its path to this
property.
\@note that whenever this property is set, even if to the
Note: that whenever this property is set, even if to the
same value, it will flush all cookies to the previously
set file, then erase all known cookies, then use the new
file (if any).

2
src/lib/ecore_con/efl_net_dialer_windows.eo
View File

@ -4,7 +4,7 @@ class Efl.Net.Dialer_Windows (Efl.Net.Socket_Windows, Efl.Net.Dialer) {
The dial address will have "\\\\.\\pipe\\" prepended as required by
Windows CreateNamedPipe().
\@note Proxies are meaningless, thus are not implemented.
Note: Proxies are meaningless, thus are not implemented.
@since 1.19
]]

4
src/lib/ecore_con/efl_net_server_fd.eo
View File

@ -14,13 +14,13 @@ class Efl.Net.Server_Fd (Efl.Loop_Fd, Efl.Net.Server) {
It will replace @Efl.Net.Server.serve, thus if this is
used, this method will return EALREADY.
\@note The parameter 'address' given to this function is
Note: The parameter 'address' given to this function is
only used to validate the next socket available. It
doesn't search for a socket with the given address. Thus
the socket to be used is the next unused one : order
matters if using multiple servers!
\@note subclasses must validate the socket and return
Note: subclasses must validate the socket and return
EINVAL prior to call the base class with
Efl.Object.super. They must also emit "serving" when
ready. For instance stream protocols may need to check

4
src/lib/ecore_con/efl_net_session.eo
View File

@ -44,7 +44,7 @@ class Efl.Net.Session (Efl.Loop_Consumer) {
state is online but those properties are NULL or technology is
unknown.
\@note the @.connect method is subject to backend policy. For
Note: the @.connect method is subject to backend policy. For
instance, ConnMan uses
https://github.com/aldebaran/connman/blob/master/doc/session-policy-format.txt
@ -95,7 +95,7 @@ class Efl.Net.Session (Efl.Loop_Consumer) {
@property state {
[[If the session connectivity is offline, local or online.
\@note if there is no backend for this class, then state
Note: if there is no backend for this class, then state
will be always online, however @.technology will be
unknown, @.interface, @.network_name, @.ipv4 and @.ipv6 will be
NULL.

2
src/lib/ecore_con/efl_net_socket_udp.eo
View File

@ -153,7 +153,7 @@ class Efl.Net.Socket_Udp (Efl.Net.Socket_Fd) {
If no address is provided or bind is not called, a
random port is bound automatically to any address.
\@note IP and PORT must be all numeric, no name
Note: IP and PORT must be all numeric, no name
resolution is applied.
]]
get { }

2
src/lib/ecore_con/efl_net_ssl_context.eo
View File

@ -11,7 +11,7 @@ class Efl.Net.Ssl.Context (Efl.Object) {
@Efl.Object.finalize in order to define the mandatory
operational parameters.
\@note All setter methods must be called before @Efl.Object.finalize.
Note: All setter methods must be called before @Efl.Object.finalize.
@since 1.19
]]

2
src/lib/efl/interfaces/efl_gfx_color.eo
View File

@ -34,8 +34,6 @@ mixin Efl.Gfx.Color
Use null pointers on the components you're not interested
in: they'll be ignored by the function.
See the full \@ref Example_Evas_Object_Manipulation "example".
]]
}
values {

4
src/lib/efl/interfaces/efl_gfx_color_class.eo
View File

@ -19,7 +19,7 @@ interface Efl.Gfx.Color_Class
Setting color emits a signal "color_class,set" with source being
the given color.
Note: These color values are expected to be premultiplied by \@p a.]]
Note: These color values are expected to be premultiplied by $a.]]
return: bool; [[$true if setting the color succeeded, $false otherwise]]
}
get {
@ -32,7 +32,7 @@ interface Efl.Gfx.Color_Class
the third is the text shadow. (Note that the second two only apply
to text parts).
Note: These color values are expected to be premultiplied by \@p a.]]
Note: These color values are expected to be premultiplied by $a.]]
return: bool; [[$true if getting the color succeeded, $false otherwise]]
}
keys {

1
src/lib/efl/interfaces/efl_gfx_image.eo
View File

@ -1,4 +1,5 @@
import efl_gfx_types;
import eina_types;
enum Efl.Gfx.Image_Content_Hint
{

2
src/lib/efl/interfaces/efl_gfx_path.eo
View File

@ -9,8 +9,6 @@ mixin Efl.Gfx.Path
[[Set the list of commands and points to be used to create the
content of path.
See \@ref efl_gfx_path interface for how to create a command list.
@since 1.18
]]
set {

16
src/lib/efl/interfaces/efl_gfx_shape.eo
View File

@ -59,10 +59,10 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
}
@property stroke_dash {
[[Set stroke dash pattern. A dash pattern is specified by dashes,
an array of Efl_Gfx_Dash. Efl_Gfx_Dash values(length, gap)
an array of @Efl.Gfx.Dash. @Efl.Gfx.Dash values(length, gap)
must be positive.
See also \@ref Efl_Gfx_Dash
See also @Efl.Gfx.Dash
]]
set {
}
@ -78,7 +78,7 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
The cap will be used for capping the end point of a
open subpath.
See also \@ref Efl_Gfx_Cap.
See also @Efl.Gfx.Cap.
@since 1.14
]]
@ -87,7 +87,7 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
get {
}
values {
c: Efl.Gfx.Cap; [[Cap style to use, default is EFL_GFX_CAP_BUTT]]
c: Efl.Gfx.Cap; [[Cap style to use, default is @Efl.Gfx.Cap.butt]]
}
}
@property stroke_join {
@ -95,7 +95,7 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
The join style will be used for joining the two line segment
while stroking the path.
See also \@ref Efl_Gfx_Join.
See also @Efl.Gfx.Join.
@since 1.14
]]
@ -104,12 +104,12 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
get {
}
values {
j: Efl.Gfx.Join; [[Join style to use, default is EFL_GFX_JOIN_MITER]]
j: Efl.Gfx.Join; [[Join style to use, default is @Efl.Gfx.Join.miter]]
}
}
@property fill_rule {
[[The fill rule of the given shape object.
$EFL_GFX_FILL_RULE_WINDING, or $EFL_GFX_FILL_RULE_ODD_EVEN.
@Efl.Gfx.Fill_Rule.winding or @Efl.Gfx.Fill_Rule.odd_even.
@since 1.14
]]
@ -119,7 +119,7 @@ mixin Efl.Gfx.Shape (Efl.Gfx.Path)
}
values {
fill_rule: Efl.Gfx.Fill_Rule; [[The current fill rule of the shape object.
One of $EFL_GFX_FILL_RULE_WINDING, $EFL_GFX_FILL_RULE_ODD_EVEN]]
One of @Efl.Gfx.Fill_Rule.winding or @Efl.Gfx.Fill_Rule.odd_even]]
}
}
}

2
src/lib/efl/interfaces/efl_gfx_size_hint.eo
View File

@ -211,7 +211,7 @@ interface Efl.Gfx.Size_Hint
scene composition.
See documentation of possible users: in Evas, they are the
\@ref Evas_Object_Box "box" and \@ref Evas_Object_Table "table"
@Efl.Ui.Box "box" and @Efl.Ui.Table "table"
smart objects.
For the horizontal component, 0.0 means to the left, 1.0

20
src/lib/efl/interfaces/efl_model.eo
View File

@ -5,7 +5,7 @@ struct Efl.Model_Property_Event {
}
struct Efl.Model_Children_Event {
[[Every time a child is added the event EFL_MODEL_EVENT_CHILD_ADDED is dispatched
[[Every time a child is added the event @[Efl.Model.child,added] is dispatched
passing along this structure.]]
index: uint; [[index is a hint and is intended to provide a way for applications
to control/know children relative positions through listings.]]
@ -24,10 +24,10 @@ interface Efl.Model ()
properties_get is due to provide callers a way the fetch the
current properties implemented/used by the model. The event
EFL_MODEL_EVENT_PROPERTIES_CHANGED will be raised to notify
@[Efl.Model.properties,changed] will be raised to notify
listeners of any modifications in the properties.
See also \@ref EFL_MODEL_EVENT_PROPERTIES_CHANGED.
See also @[Efl.Model.properties,changed].
@since 1.14
]]
@ -44,14 +44,14 @@ interface Efl.Model ()
before being able to see/set properties. This function sets
a new property value into given property name. Once the
operation is completed the concrete implementation should
raise EFL_MODEL_EVENT_PROPERTIES_CHANGED event in order to
raise @[Efl.Model.properties,changed] event in order to
notify listeners of the new value of the property.
If the model doesn't have the property then there are two
possibilities, either raise an error or create the new
property in model
See @.property.get, \@ref EFL_MODEL_EVENT_PROPERTIES_CHANGED
See @.property.get, @[Efl.Model.properties,changed]
@since 1.14
]]
@ -61,10 +61,10 @@ interface Efl.Model ()
[[Retrieve the value of a given property name.
At this point the caller is free to get values from properties.
The event EFL_MODEL_EVENT_PROPERTIES_CHANGED may be raised to
The event @[Efl.Model.properties,changed] may be raised to
notify listeners of the property/value.
See @.properties.get, \@ref EFL_MODEL_EVENT_PROPERTIES_CHANGED
See @.properties.get, @[Efl.Model.properties,changed]
@since 1.14
]]
@ -134,7 +134,7 @@ interface Efl.Model ()
When efl_model_load is completed efl_model_coildren_count_get
can be used to get the number of children. children_count_get
can also be used before calling children_slice_get so a valid
range is known. Event EFL_MODEL_CHILDREN_COUNT_CHANGED is
range is known. Event @[Efl.Model.children,count,changed] is
emitted when count is finished.
See also @.children_slice_get.
@ -151,7 +151,7 @@ interface Efl.Model ()
Add a new child, possibly dummy, depending on the implementation,
of a internal keeping. When the child is effectively
added the event \@ref EFL_MODEL_EVENT_CHILD_ADDED is then raised
added the event @[Efl.Model.child,added] is then raised
and the new child is kept along with other children.
@since 1.14
@ -162,7 +162,7 @@ interface Efl.Model ()
[[Remove a child.
Remove a child of a internal keeping. When the child is effectively
removed the event \@ref EFL_MODEL_EVENT_CHILD_REMOVED is then
removed the event @[Efl.Model.child,removed] is then
raised to give a chance for listeners to perform any cleanup
and/or update references.

2
src/lib/eio/efl_io_manager.eo
View File

@ -28,7 +28,7 @@ class Efl.Io.Manager (Efl.Loop_Consumer)
methods {
ls @const {
[[Lists entries in a given path.
See \@ref eina_file_ls().
See @Eina.File.
]]
params {
@in path: string; [[Path we want to list entries for]]

5
src/lib/elementary/efl_access_object.eo
View File

@ -310,10 +310,7 @@ mixin Efl.Access.Object (Efl.Interface, Efl.Object)
}
}
attributes_clear {
[[Removes all attributes in accessible object.
\@internal
]]
[[Removes all attributes in accessible object.]]
}
@property reading_info_type @protected {
get {

2
src/lib/elementary/efl_ui_flip.eo
View File

@ -42,7 +42,7 @@ class Efl.Ui.Flip (Efl.Ui.Widget, Efl.Pack_Linear)
and cause it to flip). By default a flip is not interactive.
You may also need to set which sides of the flip are "active"
for flipping and how much space they use (a minimum of a
finger size) with \@ref @.interaction_direction_enabled_set
finger size) with @.interaction_direction_enabled_set
and @.interaction_direction_hitsize_set.
The four available mode of interaction are

2
src/lib/elementary/efl_ui_popup_part_backwall.eo
View File

@ -9,7 +9,7 @@ class Efl.Ui.Popup_Part_Backwall (Efl.Ui.Layout_Part, Efl.File)
If $repeat is $true, it will make events on $obj to also be
repeated for the next lower object in the objects' stack (see
\@ref evas_object_below_get).
@Efl.Gfx.Stack.below).
If $repeat is $false, events occurring on $obj will be
processed only on it.

6
src/lib/emotion/efl_canvas_video.eo
View File

@ -10,8 +10,7 @@ class Efl.Canvas.Video (Efl.Canvas.Group, Efl.File, Efl.Player, Efl.Gfx.Image, E
emotion object.
Please don't use this function, consider using
\@ref emotion_object_audio_mute_set and
\@ref emotion_object_video_mute_set instead.
@Efl.Player.mute instead.
]]
legacy: emotion_object_module_option_set;
}
@ -38,8 +37,7 @@ class Efl.Canvas.Video (Efl.Canvas.Group, Efl.File, Efl.Player, Efl.Gfx.Image, E
It's possible to disable the build of a module with
--disable-module_name.
See also \@ref emotion_object_add and
\@ref emotion_object_file_set.
See also @Efl.File.file.
]]
legacy: emotion_object_init;
return: bool; [[$true if the specified module was successfully

23
src/lib/evas/canvas/efl_canvas_object.eo
View File

@ -140,7 +140,7 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
The visibility of an object affects the objects that are
clipped by it, so if the object clipping others is not shown
(as in \@ref evas_object_show), the objects clipped by it will
(as in @Efl.Gfx.Entity.visible), the objects clipped by it will
not be shown either.
If $obj was being clipped by another object when this function
@ -173,7 +173,7 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
If $repeat is $true, it will make events on $obj to also be
repeated for the next lower object in the objects' stack (see
see \@ref evas_object_below_get).
see @Efl.Gfx.Stack.below).
If $repeat is $false, events occurring on $obj will be
processed only on it.
@ -244,10 +244,7 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
at the same time. This function adds a new seat to the focus list. In other words,
after the seat is added to the list this object will now be also focused by this new seat.
This function generates an \@ref EFL_CANVAS_OBJECT_EVENT_FOCUS_DEVICE_IN event.
\@note The old focus APIs ( \@ref evas_object_focus_get, \@ref evas_object_focus_set,
@.key_grab) will still work, however they will only act on the default seat.
Note: The old focus APIs still work, however they will only act on the default seat.
@since 1.19
]]
@ -260,8 +257,6 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
seat_focus_del {
[[ Remove a seat from the focus list.
Removing an seat from the focus list is an unfocus operation, thus it will generate an
\@ref EFL_CANVAS_OBJECT_EVENT_FOCUS_DEVICE_OUT event.
@since 1.19
]]
params {
@ -354,7 +349,7 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
If $pass is $true, it will make events on $obj to be ignored.
They will be triggered on the next lower object (that is not
set to pass events), instead (see \@ref evas_object_below_get).
set to pass events), instead (see @Efl.Gfx.Stack.below).
If $pass is $false events will be processed on that object
as normal.
@ -463,16 +458,13 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
events for the given keys.
$keyname is a platform dependent symbolic name for the key
pressed (see \@ref Evas_Keys for more information).
pressed.
$modifiers and $not_modifiers are bit masks of all the
modifiers that must and mustn't, respectively, be pressed along
with $keyname key in order to trigger this new key grab.
Modifiers can be things such as Shift and Ctrl as well as
user defined types via \@ref evas_key_modifier_add. Retrieve
them with \@ref evas_key_modifier_mask_get or use 0 for empty
masks.
user defined types via @Evas.Canvas.key_modifier_add.
$exclusive will make the given object the only one permitted to
grab the given key. If given $true, subsequent calls on this
function with different $obj arguments will fail, unless the key
@ -480,9 +472,6 @@ abstract Efl.Canvas.Object (Efl.Loop_Consumer, Efl.Gfx.Entity, Efl.Gfx.Color, Ef
Warning: Providing impossible modifier sets creates undefined
behavior.
See also @.key_ungrab, @.key_focus.get, @.key_focus.set,
\@ref evas_focus_get, \@ref evas_key_modifier_add.
]]
return: bool @warn_unused; [[$true if the call succeeded, $false otherwise.]]
params {