diff options
author | Stefan Schmidt <stefan@osg.samsung.com> | 2016-11-11 15:34:08 +0100 |
---|---|---|
committer | Stefan Schmidt <stefan@osg.samsung.com> | 2016-11-11 15:34:08 +0100 |
commit | c2754dc5623372490114e790386f8382bc1a251e (patch) | |
tree | d095e0eedaf235b62706250454496e0fea28a2c4 | |
parent | 44b3fb5ebc29076de041703eb1417611ddc3f85a (diff) | |
download | efl-c2754dc5623372490114e790386f8382bc1a251e.tar.gz |
docs: efl_net_socket: add missing docs for efl_net_socket
-rw-r--r-- | src/lib/ecore_con/efl_net_socket.eo | 4 | ||||
-rw-r--r-- | src/lib/ecore_con/efl_net_socket_fd.eo | 2 | ||||
-rw-r--r-- | src/lib/ecore_con/efl_net_socket_ssl.eo | 8 | ||||
-rw-r--r-- | src/lib/ecore_con/efl_net_socket_tcp.eo | 6 | ||||
-rw-r--r-- | src/lib/ecore_con/efl_net_socket_udp.eo | 26 |
5 files changed, 23 insertions, 23 deletions
diff --git a/src/lib/ecore_con/efl_net_socket.eo b/src/lib/ecore_con/efl_net_socket.eo index fdd29edcba..e7be445422 100644 --- a/src/lib/ecore_con/efl_net_socket.eo +++ b/src/lib/ecore_con/efl_net_socket.eo @@ -25,7 +25,7 @@ interface Efl.Net.Socket (Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) { get { } set @protected { } values { - address: string; + address: string; [[Local address]] } } @@ -43,7 +43,7 @@ interface Efl.Net.Socket (Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer) { get { } set @protected { } values { - address: string; + address: string; [[Remote address]] } } } diff --git a/src/lib/ecore_con/efl_net_socket_fd.eo b/src/lib/ecore_con/efl_net_socket_fd.eo index 711d387db6..8df4c75b75 100644 --- a/src/lib/ecore_con/efl_net_socket_fd.eo +++ b/src/lib/ecore_con/efl_net_socket_fd.eo @@ -24,7 +24,7 @@ class Efl.Net.Socket.Fd (Efl.Loop.Fd, Efl.Io.Reader.Fd, Efl.Io.Writer.Fd, Efl.Io get { } set @protected { } values { - family: int; + family: int; [[Address family]] } } } diff --git a/src/lib/ecore_con/efl_net_socket_ssl.eo b/src/lib/ecore_con/efl_net_socket_ssl.eo index 71b43c4849..f32362a16d 100644 --- a/src/lib/ecore_con/efl_net_socket_ssl.eo +++ b/src/lib/ecore_con/efl_net_socket_ssl.eo @@ -14,7 +14,7 @@ class Efl.Net.Socket.Ssl (Efl.Loop_User, Efl.Net.Socket) { events { ssl,ready; [[Notifies the SSL handshake was done and the socket is now able to communicate]] - ssl,error: Eina.Error; [[an error such as @Efl.Net.Socket.Ssl.Error.HANDSHAKE]] + ssl,error: Eina.Error; [[An error such as @Efl.Net.Socket.Ssl.Error.HANDSHAKE]] } methods { @@ -36,7 +36,7 @@ class Efl.Net.Socket.Ssl (Efl.Loop_User, Efl.Net.Socket) { @property verify_mode { [[How to verify the remote peer.]] values { - verify_mode: Efl.Net.Ssl.Verify_Mode; + verify_mode: Efl.Net.Ssl.Verify_Mode; [[Remote verification mode]] } } @@ -48,7 +48,7 @@ class Efl.Net.Socket.Ssl (Efl.Loop_User, Efl.Net.Socket) { @.hostname_override. ]] values { - hostname_verify: bool; + hostname_verify: bool; [[$true if the hostname will be verified, $false otherwise]] } } @@ -66,7 +66,7 @@ class Efl.Net.Socket.Ssl (Efl.Loop_User, Efl.Net.Socket) { It's only used if @.hostname_verify is $true. ]] values { - hostname_override: string @nullable; + hostname_override: string @nullable; [[Hostname for this socket]] } } } diff --git a/src/lib/ecore_con/efl_net_socket_tcp.eo b/src/lib/ecore_con/efl_net_socket_tcp.eo index 3e6fb2955b..e7390d286c 100644 --- a/src/lib/ecore_con/efl_net_socket_tcp.eo +++ b/src/lib/ecore_con/efl_net_socket_tcp.eo @@ -15,7 +15,7 @@ class Efl.Net.Socket.Tcp (Efl.Net.Socket.Fd) { return: bool (false); [[$true on success]] } values { - keep_alive: bool; + keep_alive: bool; [[$true if keep alive is enabled, $false otherwise]] } } @@ -26,7 +26,7 @@ class Efl.Net.Socket.Tcp (Efl.Net.Socket.Fd) { return: bool (false); [[$true on success]] } values { - no_delay: bool; + no_delay: bool; [[$true if no delay is enabled, $false otherwise]] } } @@ -37,7 +37,7 @@ class Efl.Net.Socket.Tcp (Efl.Net.Socket.Fd) { return: bool (false); [[$true on success]] } values { - cork: bool; + cork: bool; [[$true if cork is enabled, $false otherwise]] } } } diff --git a/src/lib/ecore_con/efl_net_socket_udp.eo b/src/lib/ecore_con/efl_net_socket_udp.eo index 4934bd9f57..ee410725f6 100644 --- a/src/lib/ecore_con/efl_net_socket_udp.eo +++ b/src/lib/ecore_con/efl_net_socket_udp.eo @@ -18,17 +18,17 @@ class Efl.Net.Socket.Udp (Efl.Net.Socket.Fd) { This will use system calls to determine the next datagram size, in bytes. ]] - return: size; [[size in bytes]] + return: size; [[Size in bytes]] } @property cork { [[Controls UDP's cork using UDP_CORK]] get { } set { - return: bool (false); [[$true on success]] + return: bool (false); [[$true on success, $false otherwise]] } values { - cork: bool; + cork: bool; [[$true if cork is enabled for this socket, $false otherwise]] } } @@ -45,7 +45,7 @@ class Efl.Net.Socket.Udp (Efl.Net.Socket.Fd) { return: bool (false); [[$true on success]] } values { - dont_route: bool; + dont_route: bool; [[$true if do not route is enabled, $false otherwise]] } } @@ -56,18 +56,18 @@ class Efl.Net.Socket.Udp (Efl.Net.Socket.Fd) { return: bool (false); [[$true on success]] } values { - reuse_address: bool; + reuse_address: bool; [[$true if address reuse is enabled, $false otherwise]] } } @property reuse_port { - [[Controls port reuse() using SO_REUSEPORT (since linux 3.9)]] + [[Controls port reuse() using SO_REUSEPORT (since Linux 3.9)]] get { } set { return: bool (false); [[$true on success]] } values { - reuse_port: bool; + reuse_port: bool; [[$true if port reuse is enabled, $false otherwise]] } } @@ -87,9 +87,9 @@ class Efl.Net.Socket.Udp (Efl.Net.Socket.Fd) { ff02::1@1 - use loopback interface (idx=1) ]] params { - address: string @nonull; + address: string @nonull; [[Multicast address to join]] } - return: Eina.Error; + return: Eina.Error; [[0 on success, error code otherwise]] } multicast_leave { @@ -98,9 +98,9 @@ class Efl.Net.Socket.Udp (Efl.Net.Socket.Fd) { This reverses the effect of @.multicast_join. ]] params { - address: string @nonull; + address: string @nonull; [[Multicast address to leave]] } - return: Eina.Error; + return: Eina.Error; [[0 on success, error code otherwise]] } multicast_groups_get { @@ -137,7 +137,7 @@ class Efl.Net.Socket.Udp (Efl.Net.Socket.Fd) { return: Eina.Error; [[0 on success, error code otherwise]] } values { - loopback: bool; + loopback: bool; [[$true multicast packets are loopbacked, $false otherwise]] } } @@ -159,7 +159,7 @@ class Efl.Net.Socket.Udp (Efl.Net.Socket.Fd) { return: Eina.Error; [[0 on success, error code otherwise]] } values { - address: string @nonull; + address: string @nonull; [[Address to bind to]] } } } |