cedric pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=663bdcaf07a5d8550e6fe09d07a7089b1bb7a91c
commit 663bdcaf07a5d8550e6fe09d07a7089b1bb7a91c
Author: Thiep Ha thie...@gmail.com
Date: Sat Apr 25 19:35:23 2015 +0200
ecore_con: fix typos and improve document consistence.
Summary:
This patch fixes typos and uses primitive verb in brief section
to improve document consistence for ecore_con.
Reviewers: Hermet, cedric
Reviewed By: cedric
Subscribers: cedric
Differential Revision: https://phab.enlightenment.org/D2424
Signed-off-by: Cedric BAIL ced...@osg.samsung.com
---
src/lib/ecore_con/Ecore_Con.h | 180 +-
1 file changed, 90 insertions(+), 90 deletions(-)
diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h
index 2c99079..0544858 100644
--- a/src/lib/ecore_con/Ecore_Con.h
+++ b/src/lib/ecore_con/Ecore_Con.h
@@ -81,7 +81,7 @@
* retrieval of the client's ip with @ref ecore_con_client_ip_get and
* associating data with the client using ecore_con_client_data_set.
* @li ECORE_CON_EVENT_CLIENT_DEL: Whenever a client connection to an
- * @c Ecore_Con_Server, an event of this type is emitted. The contents of
+ * @c Ecore_Con_Server is destroyed, an event of this type is emitted. The
contents of
* the data with this event are variable, but if the client object in the data
* is non-null, it must be freed with @ref ecore_con_client_del.
* @li ECORE_CON_EVENT_CLIENT_DATA: Whenever a server object receives
@@ -668,7 +668,7 @@ EAPI extern int ECORE_CON_EVENT_URL_PROGRESS;
*/
/**
- * Initialises the Ecore_Con library.
+ * @brief Initialise the Ecore_Con library.
* @return Number of times the library has been initialised without being
* shut down.
*
@@ -678,7 +678,7 @@ EAPI extern int ECORE_CON_EVENT_URL_PROGRESS;
EAPI int ecore_con_init(void);
/**
- * Shuts down the Ecore_Con library.
+ * @brief Shut down the Ecore_Con library.
* @return Number of times the library has been initialised without being
* shut down.
* @note This function already calls ecore_shutdown() internally, so you don't
@@ -700,7 +700,7 @@ EAPI int ecore_con_shutdown(void);
*/
/**
- * Returns if SSL support is available
+ * @brief Return if SSL support is available
* @return 1 if SSL is available and provided by gnutls,
* 2 if SSL is available and provided by openssl,
* 0 if it is not available.
@@ -844,7 +844,7 @@ EAPI Eina_Bool
ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_
*/
/**
- * Add a SOCKS v4 proxy to the proxy list
+ * @brief Add a SOCKS v4 proxy to the proxy list
*
* Use this to create (or return, if previously added) a SOCKS proxy
* object which can be used by any ecore_con servers.
@@ -858,7 +858,7 @@ EAPI Eina_Bool
ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_
EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port,
const char *username);
/**
- * Find a SOCKS v4 proxy in the proxy list
+ * @brief Find a SOCKS v4 proxy in the proxy list
*
* Use this to determine if a SOCKS proxy was previously added by checking
* the proxy list against the parameters given.
@@ -873,7 +873,7 @@ EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const
char *ip, int port, cons
EAPI Eina_Boolecore_con_socks4_remote_exists(const char *ip, int port,
const char *username);
/**
- * Remove a SOCKS v4 proxy from the proxy list and delete it
+ * @brief Remove a SOCKS v4 proxy from the proxy list and delete it
*
* Use this to remove a SOCKS proxy from the proxy list by checking
* the list against the parameters given. The proxy will then be deleted.
@@ -887,7 +887,7 @@ EAPI Eina_Boolecore_con_socks4_remote_exists(const
char *ip, int port, c
EAPI void ecore_con_socks4_remote_del(const char *ip, int port,
const char *username);
/**
- * Add a SOCKS v5 proxy to the proxy list
+ * @brief Add a SOCKS v5 proxy to the proxy list
*
* Use this to create (or return, if previously added) a SOCKS proxy
* object which can be used by any ecore_con servers.
@@ -902,7 +902,7 @@ EAPI void ecore_con_socks4_remote_del(const
char *ip, int port, cons
EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port,
const char *username, const char *password);
/**
- * Find a SOCKS v5 proxy in the proxy list
+ * @brief Find a SOCKS v5 proxy in the proxy list
*
* Use this to determine if a SOCKS proxy was previously added by checking
* the proxy list against the parameters given.
@@ -918,7 +918,7 @@ EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const
char *ip, int port, cons
EAPI Eina_Boolecore_con_socks5_remote_exists(const char *ip, int port,
const char *username, const char *password);
/**
- * Remove a SOCKS v5 proxy from the