some fixes for doxygen
authorMartin Willi <martin@strongswan.org>
Tue, 31 Oct 2006 15:24:08 +0000 (15:24 -0000)
committerMartin Willi <martin@strongswan.org>
Tue, 31 Oct 2006 15:24:08 +0000 (15:24 -0000)
src/charon/daemon.h
src/charon/sa/authenticators/authenticator.h
src/charon/sa/authenticators/psk_authenticator.h
src/charon/sa/authenticators/rsa_authenticator.h

index 5b33498..afe8805 100644 (file)
@@ -172,6 +172,14 @@ typedef struct daemon_t daemon_t;
  */
 
 /**
+ * @defgroup authenticators authenticators
+ *
+ * Authenticator classes to prove identity of peer.
+ *
+ * @ingroup sa
+ */
+
+/**
  * @defgroup threads threads
  *
  * Threaded classes, which will do their job alone.
index 9d37a06..c7b0fc8 100644 (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);
 
index cfe6ebd..c1c5bca 100644 (file)
@@ -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);
 
index 58b4002..cc5cc01 100644 (file)
@@ -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);