[EGIT] [core/efl] master 11/12: docs: efl_net_server: add missing docs for efl_net_server

[Stefan Schmidt]

stefan pushed a commit to branch master.

http://git.enlightenment.org/core/efl.git/commit/?id=f3d12112668af2648728a983518622dabb609ac2

commit f3d12112668af2648728a983518622dabb609ac2
Author: Stefan Schmidt <ste...@osg.samsung.com>
Date:   Fri Nov 11 15:35:18 2016 +0100

    docs: efl_net_server: add missing docs for efl_net_server
---
 src/lib/ecore_con/efl_net_server_fd.eo         | 6 +++---
 src/lib/ecore_con/efl_net_server_udp.eo        | 6 +++---
 src/lib/ecore_con/efl_net_server_udp_client.eo | 2 +-
 src/lib/ecore_con/efl_net_server_unix.eo       | 2 +-
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/lib/ecore_con/efl_net_server_fd.eo 
b/src/lib/ecore_con/efl_net_server_fd.eo
index 2c494a6..dbafe1b 100644
--- a/src/lib/ecore_con/efl_net_server_fd.eo
+++ b/src/lib/ecore_con/efl_net_server_fd.eo
@@ -77,7 +77,7 @@ class Efl.Net.Server.Fd (Efl.Loop.Fd, Efl.Net.Server) {
             ]]
             get { }
             set {
-                return: bool (false); [[$true on success]]
+                return: bool (false); [[$true on success, $false otherwise]]
             }
             values {
                 close_on_exec: bool; [[If $true close on exec will be used, 
$false otherwise]]
@@ -88,7 +88,7 @@ class Efl.Net.Server.Fd (Efl.Loop.Fd, Efl.Net.Server) {
             [[Controls address reuse() using SO_REUSEADDR]]
             get { }
             set {
-                return: bool (false); [[$true on success]]
+                return: bool (false); [[$true on success, $false otherwise]]
             }
             values {
                 reuse_address: bool; [[If $true the server will reuse the 
address, $false otherwise]]
@@ -99,7 +99,7 @@ class Efl.Net.Server.Fd (Efl.Loop.Fd, Efl.Net.Server) {
             [[Controls port reuse() using SO_REUSEPORT (since linux 3.9)]]
             get { }
             set {
-                return: bool (false); [[$true on success]]
+                return: bool (false); [[$true on success, $false otherwise]]
             }
             values {
                 reuse_port: bool; [[If $true the server will reuse the port, 
$false otherwise]]
diff --git a/src/lib/ecore_con/efl_net_server_udp.eo 
b/src/lib/ecore_con/efl_net_server_udp.eo
index e631a63..f6e60f1 100644
--- a/src/lib/ecore_con/efl_net_server_udp.eo
+++ b/src/lib/ecore_con/efl_net_server_udp.eo
@@ -67,7 +67,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
             params {
                 address: string @nonull; [[Multicast group address]]
             }
-            return: Eina.Error;
+            return: Eina.Error; [[0 on success, error code otherwise]]
         }
 
         multicast_leave {
@@ -78,7 +78,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
             params {
                 address: string @nonull; [[Multicast group address]]
             }
-            return: Eina.Error;
+            return: Eina.Error; [[0 on success, error code otherwise]]
         }
 
         multicast_groups_get {
@@ -100,7 +100,7 @@ class Efl.Net.Server.Udp (Efl.Net.Server.Fd) {
                 return: Eina.Error; [[0 on success, error code otherwise]]
             }
             values {
-                loopback: bool;
+                loopback: bool; [[FIXME: should this be named ttl?]]
             }
         }
 
diff --git a/src/lib/ecore_con/efl_net_server_udp_client.eo 
b/src/lib/ecore_con/efl_net_server_udp_client.eo
index 9ef3fda..77a6fe1 100644
--- a/src/lib/ecore_con/efl_net_server_udp_client.eo
+++ b/src/lib/ecore_con/efl_net_server_udp_client.eo
@@ -20,7 +20,7 @@ class Efl.Net.Server.Udp.Client (Efl.Object, Efl.Net.Socket) {
               This will query the next pending datagram size, in
               bytes. If no datagrams are pending, 0 is returned.
             ]]
-            return: size; [[size in bytes]]
+            return: size; [[Size in bytes]]
         }
     }
 
diff --git a/src/lib/ecore_con/efl_net_server_unix.eo 
b/src/lib/ecore_con/efl_net_server_unix.eo
index 9f69758..5e87ba5 100644
--- a/src/lib/ecore_con/efl_net_server_unix.eo
+++ b/src/lib/ecore_con/efl_net_server_unix.eo
@@ -14,7 +14,7 @@ class Efl.Net.Server.Unix (Efl.Net.Server.Fd) {
               By default it's false and you will get EADDRINUSE.
             ]]
             values {
-                unlink_before_bind: bool; [[if $true, server will unlink() the 
path before bind() is called.]]
+                unlink_before_bind: bool; [[If $true, server will unlink() the 
path before bind() is called.]]
             }
         }
     }

--