Use separate Doxygen groups for IKEv1 and IKEv2 entities (authenticators, tasks etc.).
authorTobias Brunner <tobias@strongswan.org>
Fri, 18 May 2012 07:52:15 +0000 (09:52 +0200)
committerTobias Brunner <tobias@strongswan.org>
Fri, 18 May 2012 08:04:08 +0000 (10:04 +0200)
46 files changed:
src/libcharon/daemon.h
src/libcharon/sa/authenticator.h
src/libcharon/sa/ikev1/authenticators/hybrid_authenticator.h
src/libcharon/sa/ikev1/authenticators/psk_v1_authenticator.h
src/libcharon/sa/ikev1/authenticators/pubkey_v1_authenticator.h
src/libcharon/sa/ikev1/keymat_v1.h
src/libcharon/sa/ikev1/task_manager_v1.h
src/libcharon/sa/ikev1/tasks/aggressive_mode.h
src/libcharon/sa/ikev1/tasks/informational.h
src/libcharon/sa/ikev1/tasks/isakmp_cert_post.h
src/libcharon/sa/ikev1/tasks/isakmp_cert_pre.h
src/libcharon/sa/ikev1/tasks/isakmp_delete.h
src/libcharon/sa/ikev1/tasks/isakmp_dpd.h
src/libcharon/sa/ikev1/tasks/isakmp_natd.h
src/libcharon/sa/ikev1/tasks/isakmp_vendor.h
src/libcharon/sa/ikev1/tasks/main_mode.h
src/libcharon/sa/ikev1/tasks/mode_config.h
src/libcharon/sa/ikev1/tasks/quick_delete.h
src/libcharon/sa/ikev1/tasks/quick_mode.h
src/libcharon/sa/ikev1/tasks/xauth.h
src/libcharon/sa/ikev2/authenticators/eap_authenticator.h
src/libcharon/sa/ikev2/authenticators/psk_authenticator.h
src/libcharon/sa/ikev2/authenticators/pubkey_authenticator.h
src/libcharon/sa/ikev2/connect_manager.h
src/libcharon/sa/ikev2/keymat_v2.h
src/libcharon/sa/ikev2/mediation_manager.h
src/libcharon/sa/ikev2/task_manager_v2.h
src/libcharon/sa/ikev2/tasks/child_create.h
src/libcharon/sa/ikev2/tasks/child_delete.h
src/libcharon/sa/ikev2/tasks/child_rekey.h
src/libcharon/sa/ikev2/tasks/ike_auth.h
src/libcharon/sa/ikev2/tasks/ike_auth_lifetime.h
src/libcharon/sa/ikev2/tasks/ike_cert_post.h
src/libcharon/sa/ikev2/tasks/ike_cert_pre.h
src/libcharon/sa/ikev2/tasks/ike_config.h
src/libcharon/sa/ikev2/tasks/ike_delete.h
src/libcharon/sa/ikev2/tasks/ike_dpd.h
src/libcharon/sa/ikev2/tasks/ike_init.h
src/libcharon/sa/ikev2/tasks/ike_me.h
src/libcharon/sa/ikev2/tasks/ike_mobike.h
src/libcharon/sa/ikev2/tasks/ike_natd.h
src/libcharon/sa/ikev2/tasks/ike_reauth.h
src/libcharon/sa/ikev2/tasks/ike_rekey.h
src/libcharon/sa/ikev2/tasks/ike_vendor.h
src/libcharon/sa/task.h
src/libstrongswan/eap/eap.h

index 5ea3f45..c679ccb 100644 (file)
  * @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
+ * @ingroup sa
  *
- * @defgroup tasks tasks
+ * @defgroup xauth xauth
  * @ingroup sa
  *
+ * @defgroup tasks_v1 tasks
+ * @ingroup ikev1
+ *
+ * @defgroup tasks_v2 tasks
+ * @ingroup ikev2
+ *
  * @addtogroup libcharon
  * @{
  *
index 86b42da..914f42d 100644 (file)
@@ -17,7 +17,7 @@
 
 /**
  * @defgroup authenticator authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup sa
  */
 
 #ifndef AUTHENTICATOR_H_
index 6a0bb1e..69e5969 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup hybrid_authenticator hybrid_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v1
  */
 
 #ifndef HYBRID_AUTHENTICATOR_H_
index d484100..cc9e18b 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup psk_v1_authenticator psk_v1_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v1
  */
 
 #ifndef PSK_V1_AUTHENTICATOR_H_
index 154d83c..385664c 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup pubkey_v1_authenticator pubkey_v1_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v1
  */
 
 #ifndef PUBKEY_V1_AUTHENTICATOR_H_
index bb1022b..e003ed7 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup keymat_v1 keymat_v1
- * @{ @ingroup sa
+ * @{ @ingroup ikev1
  */
 
 #ifndef KEYMAT_V1_H_
index 99cd35e..61e409b 100755 (executable)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup task_manager_v1 task_manager_v1
- * @{ @ingroup sa
+ * @{ @ingroup ikev1
  */
 
 #ifndef TASK_MANAGER_V1_H_
index b532add..d0666f4 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup aggressive_mode aggressive_mode
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef AGGRESSIVE_MODE_H_
index 26d8d51..52938ff 100755 (executable)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup informational informational
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef INFORMATIONAL_H_
index 2e38df8..3a155cb 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup isakmp_cert_post isakmp_cert_post
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef ISAKMP_CERT_POST_H_
index 908cff0..8e1a94b 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup isakmp_cert_pre isakmp_cert_pre
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef ISAKMP_CERT_PRE_H_
index 3b7b40c..1a7a622 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup isakmp_delete isakmp_delete
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef ISAKMP_DELETE_H_
index 13bd34e..06a0175 100755 (executable)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup isakmp_dpd isakmp_dpd
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef ISAKMP_DPD_H_
index b83b078..63947fc 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup isakmp_natd isakmp_natd
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef ISAKMP_NATD_H_
index b81d790..9189108 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup isakmp_vendor isakmp_vendor
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef ISAKMP_VENDOR_H_
index d266b6e..141701f 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup main_mode main_mode
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef MAIN_MODE_H_
index 026545e..462bee3 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup mode_config mode_config
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef MODE_CONFIG_H_
index 8642623..4df30c8 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup quick_delete quick_delete
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef QUICK_DELETE_H_
index 295fb19..0b80cb8 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup quick_mode quick_mode
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef QUICK_MODE_H_
index c1528cc..303eb31 100644 (file)
@@ -14,8 +14,8 @@
  */
 
 /**
- * @defgroup xauth xauth
- * @{ @ingroup tasks
+ * @defgroup xauth_t xauth
+ * @{ @ingroup tasks_v1
  */
 
 #ifndef XAUTH_H_
index 15d7cb8..d81ebd5 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup eap_authenticator eap_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v2
  */
 
 #ifndef EAP_AUTHENTICATOR_H_
index ffd06f1..91c5341 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup psk_authenticator psk_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v2
  */
 
 #ifndef PSK_AUTHENTICATOR_H_
index bf95d6e..82bfea2 100644 (file)
@@ -16,7 +16,7 @@
 
 /**
  * @defgroup pubkey_authenticator pubkey_authenticator
- * @{ @ingroup authenticators
+ * @{ @ingroup authenticators_v2
  */
 
 #ifndef PUBKEY_AUTHENTICATOR_H_
index 8fa8ff6..e667e1f 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup connect_manager connect_manager
- * @{ @ingroup sa
+ * @{ @ingroup ikev2
  */
 
 #ifndef CONNECT_MANAGER_H_
index b33e713..89c65bb 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup keymat_v2 keymat_v2
- * @{ @ingroup sa
+ * @{ @ingroup ikev2
  */
 
 #ifndef KEYMAT_V2_H_
index 31a16f6..5212bdb 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup mediation_manager mediation_manager
- * @{ @ingroup sa
+ * @{ @ingroup ikev2
  */
 
 #ifndef MEDIATION_MANAGER_H_
index 3e55c98..70444ae 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup task_manager_v2 task_manager_v2
- * @{ @ingroup sa
+ * @{ @ingroup ikev2
  */
 
 #ifndef TASK_MANAGER_V2_H_
index 938b843..20f5294 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup child_create child_create
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef CHILD_CREATE_H_
index 4c8b349..1ada069 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup child_delete child_delete
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef CHILD_DELETE_H_
index 78314b0..2338465 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup child_rekey child_rekey
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef CHILD_REKEY_H_
index cf507f8..ca864a7 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_auth ike_auth
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_AUTH_H_
index 5259beb..4d5087f 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_auth_lifetime ike_auth_lifetime
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_AUTH_LIFETIME_H_
index 61d4c2d..34606b1 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_cert_post ike_cert_post
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_CERT_POST_H_
index 7de1f32..ac1a85c 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_cert_pre ike_cert_pre
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_CERT_PRE_H_
index 239e35c..e354576 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_config ike_config
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_CONFIG_H_
index 039e068..2d5d7cb 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_delete ike_delete
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_DELETE_H_
index 5865572..0268716 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_dpd ike_dpd
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_DPD_H_
index aa3cfa8..ab16995 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_init ike_init
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_INIT_H_
index a7fe0c5..44a4ce6 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_me ike_me
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_ME_H_
index 04cd33f..a7e3fe7 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_mobike ike_mobike
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_MOBIKE_H_
index 33ebfca..9c571b8 100644 (file)
@@ -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);
 };
index 52c507e..781b463 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_reauth ike_reauth
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_REAUTH_H_
index 20fcd80..6a12e90 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_rekey ike_rekey
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_REKEY_H_
index 54aad95..86c7116 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup ike_vendor ike_vendor
- * @{ @ingroup tasks
+ * @{ @ingroup tasks_v2
  */
 
 #ifndef IKE_VENDOR_H_
index 255b9a3..8bf9217 100755 (executable)
@@ -16,7 +16,7 @@
 
 /**
  * @defgroup task task
- * @{ @ingroup tasks
+ * @{ @ingroup sa
  */
 
 #ifndef TASK_H_
index 945e4bc..143232e 100644 (file)
@@ -14,7 +14,7 @@
  */
 
 /**
- * @defgroup eap eap
+ * @defgroup leap eap
  * @{ @ingroup libstrongswan
  */
 
@@ -62,7 +62,7 @@ enum eap_type_t {
        EAP_AKA = 23,
        EAP_PEAP = 25,
        EAP_MSCHAPV2 = 26,
-       EAP_MSTLV = 33, 
+       EAP_MSTLV = 33,
        EAP_TNC = 38,
        /** select EAP method dynamically based on i.e. EAP-Identity */
        EAP_DYNAMIC = 252,