fix doxygen warnings
authorcaro <caro@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Tue, 12 Oct 2010 06:34:31 +0000 (06:34 +0000)
committercaro <caro@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Tue, 12 Oct 2010 06:34:31 +0000 (06:34 +0000)
git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/ecore@53296 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

src/lib/ecore_con/Ecore_Con.h
src/lib/ecore_con/ecore_con_ssl.c

index 6bc2c23..3750084 100644 (file)
@@ -135,39 +135,56 @@ typedef struct _Ecore_Con_Url Ecore_Con_Url;
  * @{
  */
 
-/** @typedef Ecore_Con_Event_Client_Add
+/**
+ * @typedef Ecore_Con_Event_Client_Add
  * Used as the @p data param for the corresponding event
  */
 typedef struct _Ecore_Con_Event_Client_Add Ecore_Con_Event_Client_Add;
-/** @typedef Ecore_Con_Event_Client_Del
+
+/**
+ * @typedef Ecore_Con_Event_Client_Del
  * Used as the @p data param for the corresponding event
  */
 typedef struct _Ecore_Con_Event_Client_Del Ecore_Con_Event_Client_Del;
-/** @typedef Ecore_Con_Event_Server_Add
+
+/**
+ * @typedef Ecore_Con_Event_Server_Add
  * Used as the @p data param for the corresponding event
  */
 typedef struct _Ecore_Con_Event_Server_Add Ecore_Con_Event_Server_Add;
-/** @typedef Ecore_Con_Event_Server_Del
+
+/**
+ * @typedef Ecore_Con_Event_Server_Del
  * Used as the @p data param for the corresponding event
  */
 typedef struct _Ecore_Con_Event_Server_Del Ecore_Con_Event_Server_Del;
-/** @typedef Ecore_Con_Event_Client_Data
+
+/**
+ * @typedef Ecore_Con_Event_Client_Data
  * Used as the @p data param for the corresponding event
  */
 typedef struct _Ecore_Con_Event_Client_Data Ecore_Con_Event_Client_Data;
-/** @typedef Ecore_Con_Event_Server_Data
+
+/**
+ * @typedef Ecore_Con_Event_Server_Data
  * Used as the @p data param for the corresponding event
  */
 typedef struct _Ecore_Con_Event_Server_Data Ecore_Con_Event_Server_Data;
-/** @typedef Ecore_Con_Event_Url_Data
+
+/**
+ * @typedef Ecore_Con_Event_Url_Data
  * Used as the @p data param for the corresponding event
  */
 typedef struct _Ecore_Con_Event_Url_Data Ecore_Con_Event_Url_Data;
-/** @typedef Ecore_Con_Event_Url_Complete
+
+/**
+ * @typedef Ecore_Con_Event_Url_Complete
  * Used as the @p data param for the corresponding event
  */
 typedef struct _Ecore_Con_Event_Url_Complete Ecore_Con_Event_Url_Complete;
-/** @typedef Ecore_Con_Event_Url_Progress
+
+/**
+ * @typedef Ecore_Con_Event_Url_Progress
  * Used as the @p data param for the corresponding event
  */
 typedef struct _Ecore_Con_Event_Url_Progress Ecore_Con_Event_Url_Progress;
@@ -214,12 +231,9 @@ struct _Ecore_Con_Event_Server_Del
  */
 struct _Ecore_Con_Event_Client_Data
 {
- /** the client that connected */
-   Ecore_Con_Client *client;
-   /** the data that the client sent */
-   void *data;
-   /** the length of the data sent */
-   int size;
+   Ecore_Con_Client *client; /**< the client that connected */
+   void *data;               /**< the data that the client sent */
+   int size;                 /**< the length of the data sent */
 };
 
 /**
@@ -228,12 +242,9 @@ struct _Ecore_Con_Event_Client_Data
  */
 struct _Ecore_Con_Event_Server_Data
 {
- /** the server that was connected to */
-   Ecore_Con_Server *server;
-   /** the data that the server sent */
-   void *data;
-   /** the length of the data sent */
-   int size;
+   Ecore_Con_Server *server; /**< the server that was connected to */
+   void *data;               /**< the data that the server sent */
+   int size;                 /**< the length of the data sent */
 };
 
 /**
@@ -377,7 +388,9 @@ EAPI Eina_Bool         ecore_con_ssl_server_crl_add(Ecore_Con_Server *svr, const
 EAPI Eina_Bool         ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr, const char *ca_file);
 EAPI void              ecore_con_ssl_server_verify(Ecore_Con_Server *svr);
 
-/** }@ */
+/**
+ * @}
+ */
 
 /**
  * @defgroup Ecore_Con_Server_Group Ecore Connection Server Functions
@@ -435,6 +448,7 @@ EAPI void              ecore_con_client_flush(Ecore_Con_Client *cl);
 EAPI double            ecore_con_client_uptime_get(Ecore_Con_Client *cl);
 EAPI double            ecore_con_client_timeout_get(Ecore_Con_Client *cl);
 EAPI void              ecore_con_client_timeout_set(Ecore_Con_Client *cl, double timeout);
+
 /**
  * @}
  */
index 29f6cde..29a9f45 100644 (file)
@@ -231,14 +231,6 @@ ecore_con_ssl_client_write(Ecore_Con_Client *cl, unsigned char *buf, int size)
 }
 
 /**
- * @addtogroup Ecore_Con_SSL_Group Ecore Connection SSL Functions
- *
- * Functions that operate on Ecore connection objects pertaining to SSL.
- *
- * @{
- */
-
-/**
  * Returns if SSL support is available
  * @return 1 if SSL is available and provided by gnutls, 2 if provided by openssl,
  * 0 if it is not available.
@@ -251,6 +243,14 @@ ecore_con_ssl_available_get(void)
 }
 
 /**
+ * @addtogroup Ecore_Con_SSL_Group Ecore Connection SSL Functions
+ *
+ * Functions that operate on Ecore connection objects pertaining to SSL.
+ *
+ * @{
+ */
+
+/**
  * @brief Enable certificate verification on a server object
  *
  * Call this function on a server object before main loop has started
@@ -362,7 +362,9 @@ ecore_con_ssl_server_crl_add(Ecore_Con_Server *svr,
    return SSL_SUFFIX(_ecore_con_ssl_server_crl_add)(svr, crl_file);
 }
 
-/** }@ */
+/**
+ * @}
+ */
 
 #if USE_GNUTLS