q66 pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=5541f8ead1f92c8d8b04a12b3f700acb86dcda15
commit 5541f8ead1f92c8d8b04a12b3f700acb86dcda15
Author: Daniel Kolesa <d.kol...@osg.samsung.com>
Date: Fri Jun 19 15:44:22 2015 +0100
ecore_con: convert docs
---
src/lib/ecore_con/ecore_con_client.eo | 9 ++----
src/lib/ecore_con/ecore_con_server.eo | 61 +++++++++++++++++++----------------
src/lib/ecore_con/efl_network_url.eo | 8 ++---
3 files changed, 39 insertions(+), 39 deletions(-)
diff --git a/src/lib/ecore_con/ecore_con_client.eo
b/src/lib/ecore_con/ecore_con_client.eo
index e1e3c06..db6859c 100644
--- a/src/lib/ecore_con/ecore_con_client.eo
+++ b/src/lib/ecore_con/ecore_con_client.eo
@@ -2,15 +2,12 @@ class Ecore.Con.Client (Ecore.Con.Base) {
eo_prefix: ecore_con_client_obj;
methods {
@property server {
- /*@
- * Controls the server representing the socket the client has
- * connected to.
- *
- */
+ [[Controls the server representing the socket the client has
+ connected to.]]
get {
}
values {
- svr: Ecore.Con.Server *; /*@ The server the client is connected
to. */
+ svr: Ecore.Con.Server *; [[The server the client is connected to.]]
}
}
}
diff --git a/src/lib/ecore_con/ecore_con_server.eo
b/src/lib/ecore_con/ecore_con_server.eo
index 6e404e6..23cfd67 100644
--- a/src/lib/ecore_con/ecore_con_server.eo
+++ b/src/lib/ecore_con/ecore_con_server.eo
@@ -2,57 +2,62 @@ class Ecore.Con.Server (Ecore.Con.Base) {
eo_prefix: ecore_con_server_obj;
methods {
@property name {
- /*@
- * Retrieves the name of server.
- *
- * The name returned is the name used to connect on this server.
- */
+ [[Retrieves the name of server.
+
+ The name returned is the name used to connect on this server.
+ ]]
set {
legacy: null;
}
get {
}
values {
- name: const(char) *; /*@ The name of the server. */
+ name: const(char) *; [[The name of the server.]]
}
}
@property client_limit {
- /*@
- * Sets a limit on the number of clients that can be handled
concurrently
- * by the given server, and a policy on what to do if excess clients
try to
- * connect.
- *
- *
- * Beware that if you set this once ecore is already running, you may
- * already have pending CLIENT_ADD events in your event queue. Those
- * clients have already connected and will not be affected by this
call.
- * Only clients subsequently trying to connect will be affected.
- */
+ [[Sets a limit on the number of clients that can be handled
concurrently
+ by the given server, and a policy on what to do if excess clients
+ try to connect.
+
+ Beware that if you set this once ecore is already running, you may
+ already have pending CLIENT_ADD events in your event queue. Those
+ clients have already connected and will not be affected by this
call.
+ Only clients subsequently trying to connect will be affected.
+ ]]
set {
}
get {
legacy: null;
}
values {
- client_limit: int; /*@ The maximum number of clients to handle
concurrently. -1 means unlimited (default). 0 effectively disables the server.
*/
- reject_excess_clients: char; /*@ Set to 1 to automatically
disconnect excess clients as soon as they connect if you are already handling
client_limit clients. Set to 0 (default) to just hold off on the "accept()"
system call until the number of active clients drops. This causes the kernel to
queue up to 4096 connections (or your kernel's limit, whichever is lower). */
+ client_limit: int; [[The maximum number of clients to handle
+ concurrently. -1 means unlimited (default).
+ 0 effectively disables the server.]]
+ reject_excess_clients: char; [[Set to 1 to automatically
disconnect excess clients as
+ soon as they connect if you are
already handling
+ client_limit clients. Set to 0
(default) to just
+ hold off on the "accept()" system
call until the
+ number of active clients drops.
This causes the
+ kernel to queue up to 4096
connections (or your
+ kernel's limit, whichever is lower).
+ ]]
}
}
/* FIXME: Should this return an iterator? */
@property clients {
- /*@
- * Retrieves the current list of clients.
- *
- *
- * Each node in the returned list points to an @ref Ecore_Con_Client.
This list
- * cannot be modified or freed. It can also change if new clients are
connected
- * or disconnected, and will become invalid when the server is
deleted/freed.
- */
+ [[Retrieves the current list of clients.
+
+ Each node in the returned list points to an @Ecore_Con_Client. This
+ list cannot be modified or freed. It can also change if new clients
+ are connected or disconnected, and will become invalid when the
+ server is deleted/freed.
+ ]]
get {
}
values {
// FIXME: Ecore.Con.Client is needed, but that introduces a cycle
- clients: const(list<const(Ecore.Con.Base) *>) *; /*@ The list of
clients on this server. */
+ clients: const(list<const(Ecore.Con.Base) *>) *; [[The list of
clients on this server.]]
}
}
@property connection_type {
diff --git a/src/lib/ecore_con/efl_network_url.eo
b/src/lib/ecore_con/efl_network_url.eo
index 4f6f02d..eecdfd4 100644
--- a/src/lib/ecore_con/efl_network_url.eo
+++ b/src/lib/ecore_con/efl_network_url.eo
@@ -3,16 +3,14 @@ class Efl.Network.Url (Eo.Base) {
eo_prefix: efl_network_url;
methods {
@property url {
- /*@
- * Controls the URL to send the request to.
- */
+ [[Controls the URL to send the request to.]]
set {
- return: bool (false); /*@ true on success, false on error. */
+ return: bool (false); [[true on success, false on error.]]
}
get {
}
values {
- url: const(char) *; /*@ The URL */
+ url: const(char) *; [[The URL]]
}
}
}
--
