Use separate Doxygen groups for IKEv1 and IKEv2 entities (authenticators, tasks etc.).

2012-05-18 10:04:08 +02:00
parent 7959a3faec
commit 22bf44c8b9
46 changed files with 67 additions and 52 deletions
@@ -55,15 +55,30 @@
 * @defgroup sa sa
 * @ingroup libcharon
 *
- * @defgroup authenticators authenticators
+ * @defgroup ikev1 ikev1
 * @ingroup sa
 *
 * @defgroup ikev2 ikev2
 * @ingroup sa
 *
 * @defgroup authenticators_v1 authenticators
 * @ingroup ikev1
 *
 * @defgroup authenticators_v2 authenticators
 * @ingroup ikev2
 *
 * @defgroup eap eap
 * @ingroup authenticators
 *
 * @defgroup tasks tasks
 * @ingroup sa
 *
 * @defgroup xauth xauth
 * @ingroup sa
 *
 * @defgroup tasks_v1 tasks
 * @ingroup ikev1
 *
 * @defgroup tasks_v2 tasks
 * @ingroup ikev2
 *
 * @addtogroup libcharon
 * @{
 *
@@ -17,7 +17,7 @@
 /**
 * @defgroup authenticator authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup sa
 */
 #ifndef AUTHENTICATOR_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup hybrid_authenticator hybrid_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v1
 */
 #ifndef HYBRID_AUTHENTICATOR_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup psk_v1_authenticator psk_v1_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v1
 */
 #ifndef PSK_V1_AUTHENTICATOR_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup pubkey_v1_authenticator pubkey_v1_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v1
 */
 #ifndef PUBKEY_V1_AUTHENTICATOR_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup keymat_v1 keymat_v1
- * @{ @ingroup sa
+ * @{ @ingroup ikev1
 */
 #ifndef KEYMAT_V1_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup task_manager_v1 task_manager_v1
- * @{ @ingroup sa
+ * @{ @ingroup ikev1
 */
 #ifndef TASK_MANAGER_V1_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup aggressive_mode aggressive_mode
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef AGGRESSIVE_MODE_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup informational informational
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef INFORMATIONAL_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup isakmp_cert_post isakmp_cert_post
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef ISAKMP_CERT_POST_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup isakmp_cert_pre isakmp_cert_pre
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef ISAKMP_CERT_PRE_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup isakmp_delete isakmp_delete
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef ISAKMP_DELETE_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup isakmp_dpd isakmp_dpd
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef ISAKMP_DPD_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup isakmp_natd isakmp_natd
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef ISAKMP_NATD_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup isakmp_vendor isakmp_vendor
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef ISAKMP_VENDOR_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup main_mode main_mode
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef MAIN_MODE_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup mode_config mode_config
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef MODE_CONFIG_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup quick_delete quick_delete
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef QUICK_DELETE_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup quick_mode quick_mode
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef QUICK_MODE_H_
@@ -14,8 +14,8 @@
 */
 /**
- * @defgroup xauth xauth
+ * @defgroup xauth_t xauth
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
 */
 #ifndef XAUTH_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup eap_authenticator eap_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v2
 */
 #ifndef EAP_AUTHENTICATOR_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup psk_authenticator psk_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v2
 */
 #ifndef PSK_AUTHENTICATOR_H_
@@ -16,7 +16,7 @@
 /**
 * @defgroup pubkey_authenticator pubkey_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v2
 */
 #ifndef PUBKEY_AUTHENTICATOR_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup connect_manager connect_manager
- * @{ @ingroup sa
+ * @{ @ingroup ikev2
 */
 #ifndef CONNECT_MANAGER_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup keymat_v2 keymat_v2
- * @{ @ingroup sa
+ * @{ @ingroup ikev2
 */
 #ifndef KEYMAT_V2_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup mediation_manager mediation_manager
- * @{ @ingroup sa
+ * @{ @ingroup ikev2
 */
 #ifndef MEDIATION_MANAGER_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup task_manager_v2 task_manager_v2
- * @{ @ingroup sa
+ * @{ @ingroup ikev2
 */
 #ifndef TASK_MANAGER_V2_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup child_create child_create
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef CHILD_CREATE_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup child_delete child_delete
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef CHILD_DELETE_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup child_rekey child_rekey
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef CHILD_REKEY_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_auth ike_auth
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_AUTH_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_auth_lifetime ike_auth_lifetime
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_AUTH_LIFETIME_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_cert_post ike_cert_post
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_CERT_POST_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_cert_pre ike_cert_pre
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_CERT_PRE_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_config ike_config
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_CONFIG_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_delete ike_delete
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_DELETE_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_dpd ike_dpd
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_DPD_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_init ike_init
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_INIT_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_me ike_me
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_ME_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_mobike ike_mobike
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_MOBIKE_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_natd ike_natd
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_NATD_H_
@@ -42,7 +42,7 @@ struct ike_natd_t {
 	 *
 	 * MOBIKE uses NAT payloads in DPD to detect changes in the NAT mappings.
 	 *
-	 * @return 	TRUE if mappings have changed
+	 * @return	TRUE if mappings have changed
 	 */
 	bool (*has_mapping_changed)(ike_natd_t *this);
 };
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_reauth ike_reauth
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_REAUTH_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_rekey ike_rekey
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_REKEY_H_
@@ -15,7 +15,7 @@
 /**
 * @defgroup ike_vendor ike_vendor
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
 */
 #ifndef IKE_VENDOR_H_
@@ -16,7 +16,7 @@
 /**
 * @defgroup task task
- * @{ @ingroup tasks
+ * @{ @ingroup sa
 */
 #ifndef TASK_H_
@@ -14,7 +14,7 @@
 */
 /**
- * @defgroup eap eap
+ * @defgroup leap eap
 * @{ @ingroup libstrongswan
 */