cedric pushed a commit to branch master.

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

commit 3dd917be92e8312d4841d800f22045326d396804
Author: Srivardhan Hebbar <sri.heb...@samsung.com>
Date:   Fri Aug 7 16:33:38 2015 +0200

    ecore_con: update documentation.
    
    Summary: Signed-off-by: Srivardhan Hebbar <sri.heb...@samsung.com>
    
    Reviewers: cedric
    
    Reviewed By: cedric
    
    Subscribers: cedric
    
    Differential Revision: https://phab.enlightenment.org/D2909
    
    Signed-off-by: Cedric BAIL <ced...@osg.samsung.com>
---
 src/lib/ecore_con/Ecore_Con.h     |  3 +++
 src/lib/ecore_con/Ecore_Con_Eet.h | 12 ++++++++++++
 2 files changed, 15 insertions(+)

diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h
index 4fde11b..8cf39ec 100644
--- a/src/lib/ecore_con/Ecore_Con.h
+++ b/src/lib/ecore_con/Ecore_Con.h
@@ -1229,6 +1229,9 @@ EAPI Ecore_Con_Server 
*ecore_con_server_add(Ecore_Con_Type type,
  * @ref ECORE_CON_EVENT_SERVER_ADD is received. If it fails to complete, an
  * @ref ECORE_CON_EVENT_SERVER_DEL will be received.
  *
+ * The created object gets deleted automatically if the connection to the
+ * server is lost.
+ *
  * The @p data parameter can be fetched later using ecore_con_server_data_get()
  * or changed with ecore_con_server_data_set().
  */
diff --git a/src/lib/ecore_con/Ecore_Con_Eet.h 
b/src/lib/ecore_con/Ecore_Con_Eet.h
index 0257b7f..4f1b7df 100644
--- a/src/lib/ecore_con/Ecore_Con_Eet.h
+++ b/src/lib/ecore_con/Ecore_Con_Eet.h
@@ -84,6 +84,9 @@ typedef Eina_Bool (*Ecore_Con_Eet_Server_Cb)(void *data, 
Ecore_Con_Reply *reply,
  *                  created by the server program with @ref
  *                  ecore_con_server_add.
  *
+ * This object gets deleted automatically when the parent Ecore_Con_Server is
+ * deleted.
+ *
  * @return A new Ecore_Con_Eet server.
  */
 EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server);
@@ -95,6 +98,9 @@ EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server 
*server);
  *                  returned by a call to @ref ecore_con_server_connect in the
  *                  client program.
  *
+ * This object gets deleted automatically when the parent Ecore_Con_Server is
+ * deleted.
+ *
  * @return A new Ecore_Con_Eet client.
  */
 EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server);
@@ -122,6 +128,7 @@ EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const 
char *name, Eet_Data_
 
 /**
  * Register a data callback on a Ecore_Con_Eet object.
+ * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
  *
  * @param ece       An Ecore_Con_Eet object.
  * @param name      The name of the Eet stream to connect.
@@ -142,6 +149,7 @@ EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet 
*ece, const char *name);
 
 /**
  * Register a raw data callback on a Ecore_Con_Eet object.
+ * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
  *
  * @param ece       An Ecore_Con_Eet object.
  * @param name      The name of the raw Eet stream to connect.
@@ -164,6 +172,7 @@ EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet 
*ece, const char *na
  * Register a client connect callback on a Ecore_Con_Eet object.
  * @brief This callback can be registered on the server program to know when a
  * client connects.
+ * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
  *
  * @param ece       An Ecore_Con_Eet object.
  * @param func      The function to call as a callback.
@@ -184,6 +193,7 @@ EAPI void 
ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Co
  * Register a client disconnect callback on a Ecore_Con_Eet object.
  * @brief This callback can be registered on the server program to know when a
  * client disconnects.
+ * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
  *
  * @param ece       An Ecore_Con_Eet object.
  * @param func      The function to call as a callback.
@@ -204,6 +214,7 @@ EAPI void 
ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore
  * Register a server connect callback on a Ecore_Con_Eet object.
  * @brief This callback can be registered on the client program to be called
  * when it has been connected to the server.
+ * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
  *
  * @param ece       An Ecore_Con_Eet object.
  * @param func      The function to call as a callback.
@@ -224,6 +235,7 @@ EAPI void 
ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Co
  * Register a server disconnect callback on a Ecore_Con_Eet object.
  * @brief This callback can be registered on the client program to be called
  * when it has been disconnected from the server.
+ * When the Ecore_Con_Eet object is deleted, this automatically gets removed.
  *
  * @param ece       An Ecore_Con_Eet object.
  * @param func      The function to call as a callback.

-- 


Reply via email to