some fixes for doxygen

This commit is contained in:
Martin Willi
2006-10-31 15:24:08 +00:00
parent db7ef62494
commit e691a5c493
4 changed files with 16 additions and 8 deletions
+8
View File
@@ -171,6 +171,14 @@ typedef struct daemon_t daemon_t;
* @ingroup sa
*/
/**
* @defgroup authenticators authenticators
*
* Authenticator classes to prove identity of peer.
*
* @ingroup sa
*/
/**
* @defgroup threads threads
*
+4 -4
View File
@@ -34,7 +34,7 @@ typedef struct authenticator_t authenticator_t;
/**
* Method to use for authentication.
*
* @ingroup authenticator
* @ingroup authenticators
*/
enum auth_method_t {
/**
@@ -66,7 +66,7 @@ enum auth_method_t {
/**
* enum names for auth_method_t.
*
* @ingroup authenticator
* @ingroup authenticators
*/
extern enum_name_t *auth_method_names;
@@ -80,7 +80,7 @@ extern enum_name_t *auth_method_names;
* @b Constructors:
* - authenticator_create()
*
* @ingroup authenticator
* @ingroup authenticators
*/
struct authenticator_t {
@@ -132,7 +132,7 @@ struct authenticator_t {
*
* @return authenticator_t object
*
* @ingroup sa
* @ingroup authenticators
*/
authenticator_t *authenticator_create(ike_sa_t *ike_sa, auth_method_t auth_method);
@@ -34,7 +34,7 @@ typedef struct psk_authenticator_t psk_authenticator_t;
* - psk_authenticator_create()
* - authenticator_create() using auth_method AUTH_PSK
*
* @ingroup authenticator
* @ingroup authenticators
*/
struct psk_authenticator_t {
@@ -50,7 +50,7 @@ struct psk_authenticator_t {
* @param ike_sa associated ike_sa
* @return psk_authenticator_t object
*
* @ingroup authenticator
* @ingroup authenticators
*/
psk_authenticator_t *psk_authenticator_create(ike_sa_t *ike_sa);
@@ -34,7 +34,7 @@ typedef struct rsa_authenticator_t rsa_authenticator_t;
* - rsa_authenticator_create()
* - authenticator_create() using auth_method AUTH_RSA
*
* @ingroup authenticator
* @ingroup authenticators
*/
struct rsa_authenticator_t {
@@ -50,7 +50,7 @@ struct rsa_authenticator_t {
* @param ike_sa associated ike_sa
* @return rsa_authenticator_t object
*
* @ingroup authenticator
* @ingroup authenticators
*/
rsa_authenticator_t *rsa_authenticator_create(ike_sa_t *ike_sa);