summaryrefslogtreecommitdiff
path: root/src/lib/ecore_con
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2018-11-28 13:33:46 +0100
committerDaniel Kolesa <d.kolesa@samsung.com>2018-11-28 13:33:46 +0100
commit05682eed7d572874928424af82fba819790c4228 (patch)
treee95f5777ba237b378c2ceb166ce6657a6214e2fd /src/lib/ecore_con
parentc602c075cada6eb56158d398c27f57b522bafdc7 (diff)
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
Diffstat (limited to 'src/lib/ecore_con')
-rw-r--r--src/lib/ecore_con/efl_net_control_access_point.eo4
-rw-r--r--src/lib/ecore_con/efl_net_control_manager.eo4
-rw-r--r--src/lib/ecore_con/efl_net_dialer_http.eo2
-rw-r--r--src/lib/ecore_con/efl_net_dialer_unix.eo2
-rw-r--r--src/lib/ecore_con/efl_net_dialer_websocket.eo2
-rw-r--r--src/lib/ecore_con/efl_net_dialer_windows.eo2
-rw-r--r--src/lib/ecore_con/efl_net_server_fd.eo4
-rw-r--r--src/lib/ecore_con/efl_net_session.eo4
-rw-r--r--src/lib/ecore_con/efl_net_socket_udp.eo2
-rw-r--r--src/lib/ecore_con/efl_net_ssl_context.eo2
10 files changed, 14 insertions, 14 deletions
diff --git a/src/lib/ecore_con/efl_net_control_access_point.eo b/src/lib/ecore_con/efl_net_control_access_point.eo
index ec8cce7..5aaf13b 100644
--- a/src/lib/ecore_con/efl_net_control_access_point.eo
+++ b/src/lib/ecore_con/efl_net_control_access_point.eo
@@ -81,7 +81,7 @@ class Efl.Net.Control.Access_Point (Efl.Loop_Consumer) {
81 create access points to allow configuration and connection. 81 create access points to allow configuration and connection.
82 82
83 An application requiring only a network connection can just 83 An application requiring only a network connection can just
84 use a \@Efl.Net.Session instead. 84 use a @Efl.Net.Session instead.
85 85
86 @since 1.19 86 @since 1.19
87 ]] 87 ]]
@@ -177,7 +177,7 @@ class Efl.Net.Control.Access_Point (Efl.Loop_Consumer) {
177 first (most priority), then use 0. To move as the last 177 first (most priority), then use 0. To move as the last
178 priority, use UINT32_MAX or the last known priority + 1. 178 priority, use UINT32_MAX or the last known priority + 1.
179 179
180 \@note Only stored access points may be reordered 180 Note: Only stored access points may be reordered
181 among themselves. Those that are not remembered will 181 among themselves. Those that are not remembered will
182 always come last in a random order defined by the backend. 182 always come last in a random order defined by the backend.
183 ]] 183 ]]
diff --git a/src/lib/ecore_con/efl_net_control_manager.eo b/src/lib/ecore_con/efl_net_control_manager.eo
index 3250c4b..cfe9145 100644
--- a/src/lib/ecore_con/efl_net_control_manager.eo
+++ b/src/lib/ecore_con/efl_net_control_manager.eo
@@ -71,7 +71,7 @@ class Efl.Net.Control.Manager (Efl.Loop_Consumer) {
71 This class and its child objects are only useful to implement 71 This class and its child objects are only useful to implement
72 control of the network connectivity. If your application only 72 control of the network connectivity. If your application only
73 needs to request access to the network, use 73 needs to request access to the network, use
74 \@Efl.Net.Session instead. 74 @Efl.Net.Session instead.
75 75
76 Network connectivity is defined on top of technologies that 76 Network connectivity is defined on top of technologies that
77 provide access points. A technology can be "ethernet", "wifi", 77 provide access points. A technology can be "ethernet", "wifi",
@@ -142,7 +142,7 @@ class Efl.Net.Control.Manager (Efl.Loop_Consumer) {
142 142
143 - online means verified connectivity. 143 - online means verified connectivity.
144 144
145 \@note if there is no backend for this class, then state 145 Note: if there is no backend for this class, then state
146 will always be online, however @.access_points and 146 will always be online, however @.access_points and
147 @.technologies will be empty iterators (valid pointers 147 @.technologies will be empty iterators (valid pointers
148 but no items in them). 148 but no items in them).
diff --git a/src/lib/ecore_con/efl_net_dialer_http.eo b/src/lib/ecore_con/efl_net_dialer_http.eo
index 7a3f864..95a1043 100644
--- a/src/lib/ecore_con/efl_net_dialer_http.eo
+++ b/src/lib/ecore_con/efl_net_dialer_http.eo
@@ -323,7 +323,7 @@ class Efl.Net.Dialer_Http (Efl.Loop_Consumer, Efl.Net.Dialer, Efl.Io.Sizer) {
323 system, create a cookie jar and pass its path to this 323 system, create a cookie jar and pass its path to this
324 property. 324 property.
325 325
326 \@note that whenever this property is set, even if to the 326 Note: that whenever this property is set, even if to the
327 same value, it will flush all cookies to the previously 327 same value, it will flush all cookies to the previously
328 set file, then erase all known cookies. It will then use the new 328 set file, then erase all known cookies. It will then use the new
329 file (if any). 329 file (if any).
diff --git a/src/lib/ecore_con/efl_net_dialer_unix.eo b/src/lib/ecore_con/efl_net_dialer_unix.eo
index a45d2be..9686cc2 100644
--- a/src/lib/ecore_con/efl_net_dialer_unix.eo
+++ b/src/lib/ecore_con/efl_net_dialer_unix.eo
@@ -4,7 +4,7 @@ class Efl.Net.Dialer_Unix (Efl.Net.Socket_Unix, Efl.Net.Dialer) {
4 The dial address is a file system path (portable) or 4 The dial address is a file system path (portable) or
5 "abstract:ID" (Linux-only extension). 5 "abstract:ID" (Linux-only extension).
6 6
7 \@note Proxies are meaningless for AF_UNIX family, thus are not 7 Note: Proxies are meaningless for AF_UNIX family, thus are not
8 implemented. 8 implemented.
9 9
10 @since 1.19 10 @since 1.19
diff --git a/src/lib/ecore_con/efl_net_dialer_websocket.eo b/src/lib/ecore_con/efl_net_dialer_websocket.eo
index f22bf54..6c8f0f1 100644
--- a/src/lib/ecore_con/efl_net_dialer_websocket.eo
+++ b/src/lib/ecore_con/efl_net_dialer_websocket.eo
@@ -292,7 +292,7 @@ class Efl.Net.Dialer_Websocket (Efl.Loop_Consumer, Efl.Net.Dialer) {
292 system, create a cookie jar and pass its path to this 292 system, create a cookie jar and pass its path to this
293 property. 293 property.
294 294
295 \@note that whenever this property is set, even if to the 295 Note: that whenever this property is set, even if to the
296 same value, it will flush all cookies to the previously 296 same value, it will flush all cookies to the previously
297 set file, then erase all known cookies, then use the new 297 set file, then erase all known cookies, then use the new
298 file (if any). 298 file (if any).
diff --git a/src/lib/ecore_con/efl_net_dialer_windows.eo b/src/lib/ecore_con/efl_net_dialer_windows.eo
index 8826381..c15d5f8 100644
--- a/src/lib/ecore_con/efl_net_dialer_windows.eo
+++ b/src/lib/ecore_con/efl_net_dialer_windows.eo
@@ -4,7 +4,7 @@ class Efl.Net.Dialer_Windows (Efl.Net.Socket_Windows, Efl.Net.Dialer) {
4 The dial address will have "\\\\.\\pipe\\" prepended as required by 4 The dial address will have "\\\\.\\pipe\\" prepended as required by
5 Windows CreateNamedPipe(). 5 Windows CreateNamedPipe().
6 6
7 \@note Proxies are meaningless, thus are not implemented. 7 Note: Proxies are meaningless, thus are not implemented.
8 8
9 @since 1.19 9 @since 1.19
10 ]] 10 ]]
diff --git a/src/lib/ecore_con/efl_net_server_fd.eo b/src/lib/ecore_con/efl_net_server_fd.eo
index f02091a..97f192e 100644
--- a/src/lib/ecore_con/efl_net_server_fd.eo
+++ b/src/lib/ecore_con/efl_net_server_fd.eo
@@ -14,13 +14,13 @@ class Efl.Net.Server_Fd (Efl.Loop_Fd, Efl.Net.Server) {
14 It will replace @Efl.Net.Server.serve, thus if this is 14 It will replace @Efl.Net.Server.serve, thus if this is
15 used, this method will return EALREADY. 15 used, this method will return EALREADY.
16 16
17 \@note The parameter 'address' given to this function is 17 Note: The parameter 'address' given to this function is
18 only used to validate the next socket available. It 18 only used to validate the next socket available. It
19 doesn't search for a socket with the given address. Thus 19 doesn't search for a socket with the given address. Thus
20 the socket to be used is the next unused one : order 20 the socket to be used is the next unused one : order
21 matters if using multiple servers! 21 matters if using multiple servers!
22 22
23 \@note subclasses must validate the socket and return 23 Note: subclasses must validate the socket and return
24 EINVAL prior to call the base class with 24 EINVAL prior to call the base class with
25 Efl.Object.super. They must also emit "serving" when 25 Efl.Object.super. They must also emit "serving" when
26 ready. For instance stream protocols may need to check 26 ready. For instance stream protocols may need to check
diff --git a/src/lib/ecore_con/efl_net_session.eo b/src/lib/ecore_con/efl_net_session.eo
index 87ca0d0..68965ff 100644
--- a/src/lib/ecore_con/efl_net_session.eo
+++ b/src/lib/ecore_con/efl_net_session.eo
@@ -44,7 +44,7 @@ class Efl.Net.Session (Efl.Loop_Consumer) {
44 state is online but those properties are NULL or technology is 44 state is online but those properties are NULL or technology is
45 unknown. 45 unknown.
46 46
47 \@note the @.connect method is subject to backend policy. For 47 Note: the @.connect method is subject to backend policy. For
48 instance, ConnMan uses 48 instance, ConnMan uses
49 https://github.com/aldebaran/connman/blob/master/doc/session-policy-format.txt 49 https://github.com/aldebaran/connman/blob/master/doc/session-policy-format.txt
50 50
@@ -95,7 +95,7 @@ class Efl.Net.Session (Efl.Loop_Consumer) {
95 @property state { 95 @property state {
96 [[If the session connectivity is offline, local or online. 96 [[If the session connectivity is offline, local or online.
97 97
98 \@note if there is no backend for this class, then state 98 Note: if there is no backend for this class, then state
99 will be always online, however @.technology will be 99 will be always online, however @.technology will be
100 unknown, @.interface, @.network_name, @.ipv4 and @.ipv6 will be 100 unknown, @.interface, @.network_name, @.ipv4 and @.ipv6 will be
101 NULL. 101 NULL.
diff --git a/src/lib/ecore_con/efl_net_socket_udp.eo b/src/lib/ecore_con/efl_net_socket_udp.eo
index 9c22a0c..97caebc 100644
--- a/src/lib/ecore_con/efl_net_socket_udp.eo
+++ b/src/lib/ecore_con/efl_net_socket_udp.eo
@@ -153,7 +153,7 @@ class Efl.Net.Socket_Udp (Efl.Net.Socket_Fd) {
153 If no address is provided or bind is not called, a 153 If no address is provided or bind is not called, a
154 random port is bound automatically to any address. 154 random port is bound automatically to any address.
155 155
156 \@note IP and PORT must be all numeric, no name 156 Note: IP and PORT must be all numeric, no name
157 resolution is applied. 157 resolution is applied.
158 ]] 158 ]]
159 get { } 159 get { }
diff --git a/src/lib/ecore_con/efl_net_ssl_context.eo b/src/lib/ecore_con/efl_net_ssl_context.eo
index 50405da..bf69467 100644
--- a/src/lib/ecore_con/efl_net_ssl_context.eo
+++ b/src/lib/ecore_con/efl_net_ssl_context.eo
@@ -11,7 +11,7 @@ class Efl.Net.Ssl.Context (Efl.Object) {
11 @Efl.Object.finalize in order to define the mandatory 11 @Efl.Object.finalize in order to define the mandatory
12 operational parameters. 12 operational parameters.
13 13
14 \@note All setter methods must be called before @Efl.Object.finalize. 14 Note: All setter methods must be called before @Efl.Object.finalize.
15 15
16 @since 1.19 16 @since 1.19
17 ]] 17 ]]