summaryrefslogtreecommitdiff
path: root/src/lib/ecore_con
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-06-07 13:01:13 +0900
committerJaehyun Cho <jae_hyun.cho@samsung.com>2017-06-07 13:01:13 +0900
commit802b547310fc5f43d825cd3cbeb898ba056a90f6 (patch)
treebdb6075a6be63b35e981dff45a3198bbd5409d5e /src/lib/ecore_con
parent30b8c1ce82c91cc9624fa76d197f3c015cba438b (diff)
docs: Fix typos and some wrong expressions in Ecore, Ecore_Audio, Ecore_Cocoa, Ecore_Con, and Ector API reference doxygen.
Summary: I had fixed some typos and wrong expressions, such as capital letters, $simbols in .eo and singulars in Ecore, Ecore_Audio, Ecore_Cocoa, Ecore_Con, and Ector API reference doxygen. Test Plan: Doxygen Revision Reviewers: Jaehyun_Cho, stefan, jpeg, cedric, raster Reviewed By: Jaehyun_Cho Differential Revision: https://phab.enlightenment.org/D4943
Diffstat (limited to 'src/lib/ecore_con')
-rw-r--r--src/lib/ecore_con/efl_net_control.eo8
-rw-r--r--src/lib/ecore_con/efl_net_dialer_http.eo18
-rw-r--r--src/lib/ecore_con/efl_net_server_udp.eo8
3 files changed, 17 insertions, 17 deletions
diff --git a/src/lib/ecore_con/efl_net_control.eo b/src/lib/ecore_con/efl_net_control.eo
index 87b4fc0f84..6103240cb5 100644
--- a/src/lib/ecore_con/efl_net_control.eo
+++ b/src/lib/ecore_con/efl_net_control.eo
@@ -37,7 +37,7 @@ struct Efl.Net.Control.Agent_Request_Input.Information {
37} 37}
38 38
39struct Efl.Net.Control.Agent_Request_Input { 39struct Efl.Net.Control.Agent_Request_Input {
40 [[Request input to the agent. 40 [[Requests input to the agent.
41 41
42 @since 1.19 42 @since 1.19
43 ]] 43 ]]
@@ -48,7 +48,7 @@ struct Efl.Net.Control.Agent_Request_Input {
48} 48}
49 49
50struct Efl.Net.Control.Agent_Error { 50struct Efl.Net.Control.Agent_Error {
51 [[Report error to the agent. 51 [[Reports error to the agent.
52 52
53 @since 1.19 53 @since 1.19
54 ]] 54 ]]
@@ -57,7 +57,7 @@ struct Efl.Net.Control.Agent_Error {
57} 57}
58 58
59struct Efl.Net.Control.Agent_Browser_Url { 59struct Efl.Net.Control.Agent_Browser_Url {
60 [[Report to agent that it should open a browser at given URL. 60 [[Reports to agent that it should open a browser at given URL.
61 61
62 @since 1.19 62 @since 1.19
63 ]] 63 ]]
@@ -66,7 +66,7 @@ struct Efl.Net.Control.Agent_Browser_Url {
66} 66}
67 67
68class Efl.Net.Control (Efl.Loop_User) { 68class Efl.Net.Control (Efl.Loop_User) {
69 [[Control network connectivity. 69 [[Controls network connectivity.
70 70
71 This class and its children objects are only useful to implement 71 This class and its children objects are only useful to implement
72 control of the network connectivity. If your application is only 72 control of the network connectivity. If your application is only
diff --git a/src/lib/ecore_con/efl_net_dialer_http.eo b/src/lib/ecore_con/efl_net_dialer_http.eo
index 8a69600647..e7051fb2f6 100644
--- a/src/lib/ecore_con/efl_net_dialer_http.eo
+++ b/src/lib/ecore_con/efl_net_dialer_http.eo
@@ -154,7 +154,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
154 } 154 }
155 155
156 @property allow_redirects { 156 @property allow_redirects {
157 [[Allow HTTP redirects to be followed. 157 [[Allows HTTP redirects to be followed.
158 158
159 This should be set before dialing. 159 This should be set before dialing.
160 ]] 160 ]]
@@ -166,7 +166,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
166 } 166 }
167 167
168 request_header_add { 168 request_header_add {
169 [[Add a request header 'key: value'. 169 [[Adds a request header 'key: value'.
170 170
171 See @.request_headers_clear 171 See @.request_headers_clear
172 172
@@ -179,7 +179,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
179 } 179 }
180 180
181 request_headers_clear { 181 request_headers_clear {
182 [[Clear all request headers. 182 [[Clears all request headers.
183 183
184 See @.request_header_add 184 See @.request_header_add
185 185
@@ -188,7 +188,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
188 } 188 }
189 189
190 request_headers_get { 190 request_headers_get {
191 [[Return an iterator to the key-value pairs for request headers]] 191 [[Returns an iterator to the key-value pairs for request headers]]
192 return: free(own(iterator<Efl.Net.Http.Header>), eina_iterator_free) @warn_unused; [[Iterator for request headers]] 192 return: free(own(iterator<Efl.Net.Http.Header>), eina_iterator_free) @warn_unused; [[Iterator for request headers]]
193 } 193 }
194 194
@@ -242,7 +242,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
242 } 242 }
243 243
244 response_headers_get { 244 response_headers_get {
245 [[Return an iterator to the key-value pairs for the last response headers. 245 [[Returns an iterator to the key-value pairs for the last response headers.
246 246
247 Since multiple requests can happen if @.allow_redirects 247 Since multiple requests can happen if @.allow_redirects
248 is true, then all headers will be accumulated. This 248 is true, then all headers will be accumulated. This
@@ -256,7 +256,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
256 } 256 }
257 257
258 response_headers_all_get { 258 response_headers_all_get {
259 [[Return an iterator to the key-value pairs for all response headers. 259 [[Returns an iterator to the key-value pairs for all response headers.
260 260
261 Since multiple requests can happen if @.allow_redirects 261 Since multiple requests can happen if @.allow_redirects
262 is true, then all headers will be accumulated. To know 262 is true, then all headers will be accumulated. To know
@@ -281,7 +281,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
281 } 281 }
282 282
283 response_headers_clear { 283 response_headers_clear {
284 [[Save some memory by disposing the received headers]] 284 [[Saves some memory by disposing the received headers]]
285 } 285 }
286 286
287 @property progress_download { 287 @property progress_download {
@@ -364,7 +364,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
364 } 364 }
365 365
366 date_parse @class { 366 date_parse @class {
367 [[Parse the given string as time in seconds since 1/1/1970. 367 [[Parses the given string as time in seconds since 1/1/1970.
368 368
369 This method is useful to parse header values such as 369 This method is useful to parse header values such as
370 "Last-Modified". 370 "Last-Modified".
@@ -376,7 +376,7 @@ class Efl.Net.Dialer.Http (Efl.Loop_User, Efl.Net.Dialer, Efl.Io.Sizer) {
376 } 376 }
377 377
378 date_serialize @class { 378 date_serialize @class {
379 [[Serialize the given GMT time in seconds since 1/1/1970. 379 [[Serializes the given GMT time in seconds since 1/1/1970.
380 380
381 The timezone must be GMT (ie: gmtime()). 381 The timezone must be GMT (ie: gmtime()).
382 ]] 382 ]]
diff --git a/src/lib/ecore_con/efl_net_server_udp.eo b/src/lib/ecore_con/efl_net_server_udp.eo
index 21c644e6e1..6166e0c4f3 100644
--- a/src/lib/ecore_con/efl_net_server_udp.eo
+++ b/src/lib/ecore_con/efl_net_server_udp.eo
@@ -33,7 +33,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
33 } 33 }
34 34
35 @property dont_route { 35 @property dont_route {
36 [[Avoid sent UDP packets being routed by a gateway, limiting them to the local network. 36 [[Avoids sent UDP packets being routed by a gateway, limiting them to the local network.
37 37
38 This will use SO_DONTROUTE option to avoid gateways 38 This will use SO_DONTROUTE option to avoid gateways
39 routing sent packets to outside of local network. It's 39 routing sent packets to outside of local network. It's
@@ -50,7 +50,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
50 } 50 }
51 51
52 multicast_join { 52 multicast_join {
53 [[Join a multicast group. 53 [[Joins a multicast group.
54 54
55 The multicast address should be in the format: 55 The multicast address should be in the format:
56 56
@@ -71,7 +71,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
71 } 71 }
72 72
73 multicast_leave { 73 multicast_leave {
74 [[Leave a multicast group. 74 [[Leaves a multicast group.
75 75
76 This reverses the effect of @.multicast_join. 76 This reverses the effect of @.multicast_join.
77 ]] 77 ]]
@@ -82,7 +82,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
82 } 82 }
83 83
84 multicast_groups_get { 84 multicast_groups_get {
85 [[Return the multicast groups this server has joined. 85 [[Returns the multicast groups this server has joined.
86 86
87 The iterator is only valid until a new group is joined 87 The iterator is only valid until a new group is joined
88 or left using @.multicast_join or @.multicast_leave. 88 or left using @.multicast_join or @.multicast_leave.