summaryrefslogtreecommitdiff
path: root/src/lib/ecore_con
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-10 16:05:44 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-09-10 16:05:44 +0200
commit96d8b9bc3e5b14e2a8ad004debffa220ff28e36d (patch)
tree1f8519272ff81671fe5cc3f8b4edaa69258eb793 /src/lib/ecore_con
parent08e5b09d0a985d4d556c2a22dbae93ed9e45cfa4 (diff)
docs: nicer formatting of the NULL keyword, everywhere
Diffstat (limited to 'src/lib/ecore_con')
-rw-r--r--src/lib/ecore_con/efl_net_dialer.eo4
-rw-r--r--src/lib/ecore_con/efl_net_dialer_http.eo6
-rw-r--r--src/lib/ecore_con/efl_net_dialer_ssl.eo4
-rw-r--r--src/lib/ecore_con/efl_net_dialer_tcp.eo4
-rw-r--r--src/lib/ecore_con/efl_net_dialer_websocket.eo2
-rw-r--r--src/lib/ecore_con/efl_net_ip_address.eo2
-rw-r--r--src/lib/ecore_con/efl_net_session.eo6
-rw-r--r--src/lib/ecore_con/efl_net_socket_ssl.eo6
-rw-r--r--src/lib/ecore_con/efl_net_ssl_context.eo2
9 files changed, 18 insertions, 18 deletions
diff --git a/src/lib/ecore_con/efl_net_dialer.eo b/src/lib/ecore_con/efl_net_dialer.eo
index 47685e1..8570e65 100644
--- a/src/lib/ecore_con/efl_net_dialer.eo
+++ b/src/lib/ecore_con/efl_net_dialer.eo
@@ -74,7 +74,7 @@ interface @beta Efl.Net.Dialer extends Efl.Net.Socket {
74 'http'. 74 'http'.
75 75
76 Whenever appropriate dialers may use system proxy if the 76 Whenever appropriate dialers may use system proxy if the
77 proxy is NULL (the default). To forcefully disable 77 proxy is $NULL (the default). To forcefully disable
78 proxy, use an empty string (""). 78 proxy, use an empty string ("").
79 79
80 - http://username:password\@proxyserver:port 80 - http://username:password\@proxyserver:port
@@ -91,7 +91,7 @@ interface @beta Efl.Net.Dialer extends Efl.Net.Socket {
91 get { } 91 get { }
92 set { } 92 set { }
93 values { 93 values {
94 proxy_url: string; [[May be empty or NULL to unset]] 94 proxy_url: string; [[May be empty or $NULL to unset]]
95 } 95 }
96 } 96 }
97 97
diff --git a/src/lib/ecore_con/efl_net_dialer_http.eo b/src/lib/ecore_con/efl_net_dialer_http.eo
index ceca602..59701a3 100644
--- a/src/lib/ecore_con/efl_net_dialer_http.eo
+++ b/src/lib/ecore_con/efl_net_dialer_http.eo
@@ -31,7 +31,7 @@ class @beta Efl.Net.Dialer_Http extends Efl.Loop_Consumer implements Efl.Net.Dia
31 To enable debugging use EINA_LOG_LEVELS=ecore_con:4 environment 31 To enable debugging use EINA_LOG_LEVELS=ecore_con:4 environment
32 variable. 32 variable.
33 33
34 If the proxy is NULL (default), then the system proxy will be 34 If the proxy is $NULL (default), then the system proxy will be
35 used. On UNIX that's the environment variable $http_proxy (or 35 used. On UNIX that's the environment variable $http_proxy (or
36 '$all_proxy') is used if the given address doesn't match 36 '$all_proxy') is used if the given address doesn't match
37 $no_proxy patterns. To disable proxy use an empty string. If 37 $no_proxy patterns. To disable proxy use an empty string. If
@@ -259,7 +259,7 @@ class @beta Efl.Net.Dialer_Http extends Efl.Loop_Consumer implements Efl.Net.Dia
259 Since multiple requests can occur if @.allow_redirects 259 Since multiple requests can occur if @.allow_redirects
260 is true, then all headers will be accumulated. To know 260 is true, then all headers will be accumulated. To know
261 when a new request's been started, check for headers with keys 261 when a new request's been started, check for headers with keys
262 being NULL. The value will be the "HTTP/VERSION RESPONSE" 262 being $NULL. The value will be the "HTTP/VERSION RESPONSE"
263 string received from the host, such as: 263 string received from the host, such as:
264 264
265 - key=NULL, value="HTTP/1.1 302 Found" 265 - key=NULL, value="HTTP/1.1 302 Found"
@@ -381,7 +381,7 @@ class @beta Efl.Net.Dialer_Http extends Efl.Loop_Consumer implements Efl.Net.Dia
381 params { 381 params {
382 epochtime: int64; [[UNIX Epoch time - seconds since 1/1/1970]] 382 epochtime: int64; [[UNIX Epoch time - seconds since 1/1/1970]]
383 } 383 }
384 return: mstring @move @no_unused; [[Newly allocated null-terminated string on success or NULL on errors]] 384 return: mstring @move @no_unused; [[Newly allocated null-terminated string on success or $NULL on errors]]
385 } 385 }
386 } 386 }
387 387
diff --git a/src/lib/ecore_con/efl_net_dialer_ssl.eo b/src/lib/ecore_con/efl_net_dialer_ssl.eo
index 6172bd2..9bb7417 100644
--- a/src/lib/ecore_con/efl_net_dialer_ssl.eo
+++ b/src/lib/ecore_con/efl_net_dialer_ssl.eo
@@ -4,12 +4,12 @@ class @beta Efl.Net.Dialer_Ssl extends Efl.Net.Socket_Ssl implements Efl.Net.Dia
4 This creates an internal @Efl.Net.Dialer_Tcp and once connected 4 This creates an internal @Efl.Net.Dialer_Tcp and once connected
5 it will start the SSL handshake. 5 it will start the SSL handshake.
6 6
7 If the proxy is NULL (default), then the system proxy will be 7 If the proxy is $NULL (default), then the system proxy will be
8 used. On UNIX that's the environment variable $socks_proxy (or 8 used. On UNIX that's the environment variable $socks_proxy (or
9 '$proxy' or '$all_proxy') is used if the given address doesn't 9 '$proxy' or '$all_proxy') is used if the given address doesn't
10 match $no_proxy patterns. To disable proxy use an empty string. 10 match $no_proxy patterns. To disable proxy use an empty string.
11 11
12 If the proxy is NULL (default), then the system proxy will be 12 If the proxy is $NULL (default), then the system proxy will be
13 used. On UNIX that's the environment variable $socks_proxy (or 13 used. On UNIX that's the environment variable $socks_proxy (or
14 '$all_proxy') is used if the given address doesn't match 14 '$all_proxy') is used if the given address doesn't match
15 $no_proxy patterns. To disable proxy use an empty string. If 15 $no_proxy patterns. To disable proxy use an empty string. If
diff --git a/src/lib/ecore_con/efl_net_dialer_tcp.eo b/src/lib/ecore_con/efl_net_dialer_tcp.eo
index 4b01aee..424ef0b 100644
--- a/src/lib/ecore_con/efl_net_dialer_tcp.eo
+++ b/src/lib/ecore_con/efl_net_dialer_tcp.eo
@@ -1,12 +1,12 @@
1class @beta Efl.Net.Dialer_Tcp extends Efl.Net.Socket_Tcp implements Efl.Net.Dialer { 1class @beta Efl.Net.Dialer_Tcp extends Efl.Net.Socket_Tcp implements Efl.Net.Dialer {
2 [[Connects to a remote TCP server. 2 [[Connects to a remote TCP server.
3 3
4 If the proxy is NULL (default), then the system proxy will be 4 If the proxy is $NULL (default), then the system proxy will be
5 used. On UNIX that's the environment variable $socks_proxy (or 5 used. On UNIX that's the environment variable $socks_proxy (or
6 '$proxy' or '$all_proxy') is used if the given address doesn't 6 '$proxy' or '$all_proxy') is used if the given address doesn't
7 match $no_proxy patterns. To disable proxy use an empty string. 7 match $no_proxy patterns. To disable proxy use an empty string.
8 8
9 If the proxy is NULL (default), then the system proxy will be 9 If the proxy is $NULL (default), then the system proxy will be
10 used. On UNIX that's the environment variable $socks_proxy (or 10 used. On UNIX that's the environment variable $socks_proxy (or
11 '$all_proxy') is used if the given address doesn't match 11 '$all_proxy') is used if the given address doesn't match
12 $no_proxy patterns. To disable proxy use an empty string. If 12 $no_proxy patterns. To disable proxy use an empty string. If
diff --git a/src/lib/ecore_con/efl_net_dialer_websocket.eo b/src/lib/ecore_con/efl_net_dialer_websocket.eo
index 5224030..4bd96a5 100644
--- a/src/lib/ecore_con/efl_net_dialer_websocket.eo
+++ b/src/lib/ecore_con/efl_net_dialer_websocket.eo
@@ -52,7 +52,7 @@ class @beta Efl.Net.Dialer_Websocket extends Efl.Loop_Consumer implements Efl.Ne
52 not a subclass and thus not all HTTP features are exposed as the 52 not a subclass and thus not all HTTP features are exposed as the
53 WebSocket has strict requirements that must be respected. 53 WebSocket has strict requirements that must be respected.
54 54
55 If the proxy is NULL (default), then the system proxy will be 55 If the proxy is $NULL (default), then the system proxy will be
56 used. On UNIX that's the environment variable $http_proxy (or 56 used. On UNIX that's the environment variable $http_proxy (or
57 '$all_proxy') is used if the given address doesn't match 57 '$all_proxy') is used if the given address doesn't match
58 $no_proxy patterns. To disable the proxy use an empty string. If 58 $no_proxy patterns. To disable the proxy use an empty string. If
diff --git a/src/lib/ecore_con/efl_net_ip_address.eo b/src/lib/ecore_con/efl_net_ip_address.eo
index d1be8b7..69b2e54 100644
--- a/src/lib/ecore_con/efl_net_ip_address.eo
+++ b/src/lib/ecore_con/efl_net_ip_address.eo
@@ -85,7 +85,7 @@ class @beta Efl.Net.Ip_Address extends Efl.Object {
85 params { 85 params {
86 numeric_address: string; [[The numeric address to parse, such as '127.0.0.1:1234' or '[::1]:1234']] 86 numeric_address: string; [[The numeric address to parse, such as '127.0.0.1:1234' or '[::1]:1234']]
87 } 87 }
88 return: Efl.Net.Ip_Address @move; [[The new IP address object or NULL if it failed to parse]] 88 return: Efl.Net.Ip_Address @move; [[The new IP address object or $NULL if it failed to parse]]
89 } 89 }
90 90
91 resolve @static { 91 resolve @static {
diff --git a/src/lib/ecore_con/efl_net_session.eo b/src/lib/ecore_con/efl_net_session.eo
index d9f55e5..745dc68 100644
--- a/src/lib/ecore_con/efl_net_session.eo
+++ b/src/lib/ecore_con/efl_net_session.eo
@@ -34,10 +34,10 @@ class @beta Efl.Net.Session extends Efl.Loop_Consumer {
34 Some platforms may not implement the backend for this class. In 34 Some platforms may not implement the backend for this class. In
35 this cases the system will report always @.state "online" 35 this cases the system will report always @.state "online"
36 (@Efl.Net.Session_State.online) and other properties will be 36 (@Efl.Net.Session_State.online) and other properties will be
37 NULL, such as @.network_name, @.interface, @.ipv4 and @.ipv6; as well as 37 $NULL, such as @.network_name, @.interface, @.ipv4 and @.ipv6; as well as
38 @.technology is set to @Efl.Net.Session_Technology.unknown. As such 38 @.technology is set to @Efl.Net.Session_Technology.unknown. As such
39 if you need to detect for an actual backend, check if the 39 if you need to detect for an actual backend, check if the
40 state is online but those properties are NULL or technology is 40 state is online but those properties are $NULL or technology is
41 unknown. 41 unknown.
42 42
43 Note: the @.connect method is subject to backend policy. For 43 Note: the @.connect method is subject to backend policy. For
@@ -92,7 +92,7 @@ class @beta Efl.Net.Session extends Efl.Loop_Consumer {
92 Note: if there is no backend for this class, then state 92 Note: if there is no backend for this class, then state
93 will be always online, however @.technology will be 93 will be always online, however @.technology will be
94 unknown, @.interface, @.network_name, @.ipv4 and @.ipv6 will be 94 unknown, @.interface, @.network_name, @.ipv4 and @.ipv6 will be
95 NULL. 95 $NULL.
96 ]] 96 ]]
97 get { } 97 get { }
98 values { 98 values {
diff --git a/src/lib/ecore_con/efl_net_socket_ssl.eo b/src/lib/ecore_con/efl_net_socket_ssl.eo
index 31fcb30..7bf9b4c 100644
--- a/src/lib/ecore_con/efl_net_socket_ssl.eo
+++ b/src/lib/ecore_con/efl_net_socket_ssl.eo
@@ -37,8 +37,8 @@ class @beta Efl.Net.Socket_Ssl extends Efl.Loop_Consumer implements Efl.Net.Sock
37 return: bool(false); [[$true if adopted, $false otherwise]] 37 return: bool(false); [[$true if adopted, $false otherwise]]
38 } 38 }
39 values { 39 values {
40 efl_net_socket: Efl.Net.Socket; [[The adopted object, if any, otherwise NULL]] 40 efl_net_socket: Efl.Net.Socket; [[The adopted object, if any, otherwise $NULL]]
41 ctx: Efl.Net.Ssl.Context; [[The SSL context used when adopting the socket, if any, otherwise NULL]] 41 ctx: Efl.Net.Ssl.Context; [[The SSL context used when adopting the socket, if any, otherwise $NULL]]
42 } 42 }
43 } 43 }
44 44
@@ -68,7 +68,7 @@ class @beta Efl.Net.Socket_Ssl extends Efl.Loop_Consumer implements Efl.Net.Sock
68 address but the server certificate only specifies DNS 68 address but the server certificate only specifies DNS
69 (names). 69 (names).
70 70
71 If NULL, then it will fetch from socket using 71 If $NULL, then it will fetch from socket using
72 @Efl.Net.Socket.address_remote or 72 @Efl.Net.Socket.address_remote or
73 @Efl.Net.Dialer.address_dial. 73 @Efl.Net.Dialer.address_dial.
74 74
diff --git a/src/lib/ecore_con/efl_net_ssl_context.eo b/src/lib/ecore_con/efl_net_ssl_context.eo
index cddbafd..fe543d2 100644
--- a/src/lib/ecore_con/efl_net_ssl_context.eo
+++ b/src/lib/ecore_con/efl_net_ssl_context.eo
@@ -115,7 +115,7 @@ class @beta Efl.Net.Ssl.Context extends Efl.Object {
115 This is useful to avoid replicating a hostname in all 115 This is useful to avoid replicating a hostname in all
116 socket wrapper with hostname_override. 116 socket wrapper with hostname_override.
117 117
118 If NULL, then sockets wrappers will will fetch from 118 If $NULL, then sockets wrappers will will fetch from
119 adopted socket using address_remote or 119 adopted socket using address_remote or
120 address_dial. 120 address_dial.
121 121