fix doxygen warnings

SVN revision: 53296
This commit is contained in:
Vincent Torri 2010-10-12 06:34:31 +00:00
parent 6eb28124cb
commit eeb330adc3
2 changed files with 47 additions and 31 deletions

View 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 * Used as the @p data param for the corresponding event
*/ */
typedef struct _Ecore_Con_Event_Client_Add Ecore_Con_Event_Client_Add; 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 * Used as the @p data param for the corresponding event
*/ */
typedef struct _Ecore_Con_Event_Client_Del Ecore_Con_Event_Client_Del; 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 * Used as the @p data param for the corresponding event
*/ */
typedef struct _Ecore_Con_Event_Server_Add Ecore_Con_Event_Server_Add; 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 * Used as the @p data param for the corresponding event
*/ */
typedef struct _Ecore_Con_Event_Server_Del Ecore_Con_Event_Server_Del; 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 * Used as the @p data param for the corresponding event
*/ */
typedef struct _Ecore_Con_Event_Client_Data Ecore_Con_Event_Client_Data; 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 * Used as the @p data param for the corresponding event
*/ */
typedef struct _Ecore_Con_Event_Server_Data Ecore_Con_Event_Server_Data; 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 * Used as the @p data param for the corresponding event
*/ */
typedef struct _Ecore_Con_Event_Url_Data Ecore_Con_Event_Url_Data; 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 * Used as the @p data param for the corresponding event
*/ */
typedef struct _Ecore_Con_Event_Url_Complete Ecore_Con_Event_Url_Complete; 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 * Used as the @p data param for the corresponding event
*/ */
typedef struct _Ecore_Con_Event_Url_Progress Ecore_Con_Event_Url_Progress; 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 struct _Ecore_Con_Event_Client_Data
{ {
/** the client that connected */ Ecore_Con_Client *client; /**< the client that connected */
Ecore_Con_Client *client; void *data; /**< the data that the client sent */
/** the data that the client sent */ int size; /**< the length of the data sent */
void *data;
/** the length of the data sent */
int size;
}; };
/** /**
@ -228,12 +242,9 @@ struct _Ecore_Con_Event_Client_Data
*/ */
struct _Ecore_Con_Event_Server_Data struct _Ecore_Con_Event_Server_Data
{ {
/** the server that was connected to */ Ecore_Con_Server *server; /**< the server that was connected to */
Ecore_Con_Server *server; void *data; /**< the data that the server sent */
/** the data that the server sent */ int size; /**< the length of the data sent */
void *data;
/** the length of the data sent */
int size;
}; };
/** /**
@ -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 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); EAPI void ecore_con_ssl_server_verify(Ecore_Con_Server *svr);
/** }@ */ /**
* @}
*/
/** /**
* @defgroup Ecore_Con_Server_Group Ecore Connection Server Functions * @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_uptime_get(Ecore_Con_Client *cl);
EAPI double ecore_con_client_timeout_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); EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double timeout);
/** /**
* @} * @}
*/ */

View File

@ -230,14 +230,6 @@ ecore_con_ssl_client_write(Ecore_Con_Client *cl, unsigned char *buf, int size)
return SSL_SUFFIX(_ecore_con_ssl_client_write) (cl, buf, size); return SSL_SUFFIX(_ecore_con_ssl_client_write) (cl, buf, 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 * Returns if SSL support is available
* @return 1 if SSL is available and provided by gnutls, 2 if provided by openssl, * @return 1 if SSL is available and provided by gnutls, 2 if provided by openssl,
@ -250,6 +242,14 @@ ecore_con_ssl_available_get(void)
return _ECORE_CON_SSL_AVAILABLE; return _ECORE_CON_SSL_AVAILABLE;
} }
/**
* @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 * @brief Enable certificate verification on a server object
* *
@ -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); return SSL_SUFFIX(_ecore_con_ssl_server_crl_add)(svr, crl_file);
} }
/** }@ */ /**
* @}
*/
#if USE_GNUTLS #if USE_GNUTLS