Fixed all doxygen warnings
authorMartin Willi <martin@strongswan.org>
Thu, 22 Oct 2009 12:34:10 +0000 (14:34 +0200)
committerMartin Willi <martin@strongswan.org>
Thu, 22 Oct 2009 12:34:10 +0000 (14:34 +0200)
34 files changed:
src/charon/bus/listeners/listener.h
src/charon/plugins/eap_aka_3gpp2/eap_aka_3gpp2_card.h
src/charon/plugins/eap_aka_3gpp2/eap_aka_3gpp2_functions.h
src/charon/plugins/eap_aka_3gpp2/eap_aka_3gpp2_provider.h
src/charon/plugins/eap_sim_file/eap_sim_file_card.h
src/charon/plugins/eap_sim_file/eap_sim_file_provider.h
src/charon/plugins/eap_sim_file/eap_sim_file_triplets.h
src/charon/plugins/load_tester/load_tester_diffie_hellman.h
src/charon/plugins/nm/nm_handler.h
src/charon/plugins/resolve/resolve_handler.h
src/charon/plugins/updown/updown_listener.h
src/charon/sa/keymat.h
src/charon/sa/trap_manager.h
src/libstrongswan/attributes/attribute_handler.h
src/libstrongswan/attributes/attributes.h
src/libstrongswan/credentials/keys/key_encoding.h
src/libstrongswan/credentials/keys/private_key.h
src/libstrongswan/credentials/keys/public_key.h
src/libstrongswan/crypto/crypto_tester.h
src/libstrongswan/crypto/hashers/hasher.h
src/libstrongswan/integrity_checker.h
src/libstrongswan/plugins/attr_sql/attr_sql_plugin.h
src/libstrongswan/plugins/attr_sql/sql_attribute.h
src/libstrongswan/plugins/padlock/padlock_rng.h
src/libstrongswan/plugins/pem/pem_builder.h
src/libstrongswan/plugins/pgp/pgp_builder.h
src/libstrongswan/plugins/pgp/pgp_cert.h
src/libstrongswan/plugins/pgp/pgp_encoder.h
src/libstrongswan/plugins/pgp/pgp_plugin.h
src/libstrongswan/plugins/pgp/pgp_utils.h
src/libstrongswan/plugins/pkcs1/pkcs1_builder.h
src/libstrongswan/plugins/pkcs1/pkcs1_encoder.h
src/libstrongswan/plugins/pkcs1/pkcs1_plugin.h
src/pki/pki.h

index 4cd14e2..1ff8c7c 100644 (file)
@@ -176,4 +176,4 @@ struct listener_t {
                                          bool final, bool *success);
 };
 
-#endif /* LISTENER_ @}*/
+#endif /** LISTENER_H_ @}*/
index 1849d7b..b95bc52 100644 (file)
@@ -50,4 +50,4 @@ struct eap_aka_3gpp2_card_t {
  */
 eap_aka_3gpp2_card_t *eap_aka_3gpp2_card_create(eap_aka_3gpp2_functions_t *f);
 
-#endif /** EAP_AKA_3GPP2_CARD_ @}*/
+#endif /** EAP_AKA_3GPP2_CARD_H_ @}*/
index ed7f62a..1d999d6 100644 (file)
@@ -122,4 +122,4 @@ struct eap_aka_3gpp2_functions_t {
  */
 eap_aka_3gpp2_functions_t *eap_aka_3gpp2_functions_create();
 
-#endif /** EAP_AKA_3GPP2_FUNCTIONS_ @}*/
+#endif /** EAP_AKA_3GPP2_FUNCTIONS_H_ @}*/
index 6342f92..22ac0a9 100644 (file)
@@ -49,4 +49,4 @@ struct eap_aka_3gpp2_provider_t {
 eap_aka_3gpp2_provider_t *eap_aka_3gpp2_provider_create(
                                                                                                eap_aka_3gpp2_functions_t *f);
 
-#endif /** EAP_AKA_3GPP2_PROVIDER_ @}*/
+#endif /** EAP_AKA_3GPP2_PROVIDER_H_ @}*/
index 405fbce..1a54709 100644 (file)
@@ -50,4 +50,4 @@ struct eap_sim_file_card_t {
  */
 eap_sim_file_card_t *eap_sim_file_card_create(eap_sim_file_triplets_t *triplets);
 
-#endif /** EAP_SIM_FILE_CARD_ @}*/
+#endif /** EAP_SIM_FILE_CARD_H_ @}*/
index 245923b..10fda28 100644 (file)
@@ -47,4 +47,4 @@ struct eap_sim_file_provider_t {
 eap_sim_file_provider_t *eap_sim_file_provider_create(
                                                                                        eap_sim_file_triplets_t *triplets);
 
-#endif /** EAP_SIM_FILE_PROVIDER_ @}*/
+#endif /** EAP_SIM_FILE_PROVIDER_H_ @}*/
index efa2bd3..8f81308 100644 (file)
@@ -53,4 +53,4 @@ struct eap_sim_file_triplets_t {
  */
 eap_sim_file_triplets_t *eap_sim_file_triplets_create(char *file);
 
-#endif /** EAP_SIM_FILE_TRIPLETS_ @}*/
+#endif /** EAP_SIM_FILE_TRIPLETS_H_ @}*/
index 1014429..672157f 100644 (file)
@@ -45,4 +45,4 @@ struct load_tester_diffie_hellman_t {
 load_tester_diffie_hellman_t *load_tester_diffie_hellman_create(
                                                                                                diffie_hellman_group_t group);
 
-#endif /** LOAD_TESTER_DIFFIE_HELLMAN_ @}*/
+#endif /** LOAD_TESTER_DIFFIE_HELLMAN_H_ @}*/
index 6c15ae6..bb35ce7 100644 (file)
@@ -59,4 +59,4 @@ struct nm_handler_t {
  */
 nm_handler_t *nm_handler_create();
 
-#endif /* NM_HANDLER_ @}*/
+#endif /** NM_HANDLER_H_ @}*/
index 8a2c77f..77bf978 100644 (file)
@@ -14,8 +14,8 @@
  */
 
 /**
- * @defgroup resolv_conf_handler resolv_conf_handler
- * @{ @ingroup resolv_conf
+ * @defgroup resolve_handler resolve_handler
+ * @{ @ingroup resolve
  */
 
 #ifndef RESOLVE_HANDLER_H_
@@ -46,4 +46,4 @@ struct resolve_handler_t {
  */
 resolve_handler_t *resolve_handler_create();
 
-#endif /* RESOLVE_HANDLER_ @}*/
+#endif /** RESOLVE_HANDLER_H_ @}*/
index 7b978b0..5b866c4 100644 (file)
@@ -46,4 +46,4 @@ struct updown_listener_t {
  */
 updown_listener_t *updown_listener_create();
 
-#endif /** UPDOWN_LISTENER_ @}*/
+#endif /** UPDOWN_LISTENER_H_ @}*/
index cc0a3e1..e51709e 100644 (file)
@@ -160,4 +160,4 @@ struct keymat_t {
  */
 keymat_t *keymat_create(bool initiator);
 
-#endif /** KEYMAT_ @}*/
+#endif /** KEYMAT_H_ @}*/
index 9a39229..37b42e2 100644 (file)
@@ -78,4 +78,4 @@ struct trap_manager_t {
  */
 trap_manager_t *trap_manager_create();
 
-#endif /* TRAP_MANAGER_ @}*/
+#endif /** TRAP_MANAGER_H_ @}*/
index fba40b2..c9b668c 100644 (file)
@@ -58,4 +58,4 @@ struct attribute_handler_t {
                                        configuration_attribute_type_t type, chunk_t data);
 };
 
-#endif /* ATTRIBUTE_HANDLER_ @}*/
+#endif /** ATTRIBUTE_HANDLER_H_ @}*/
index 5365fd0..efc427c 100644 (file)
@@ -15,7 +15,7 @@
  */
 
 /**
- * @defgroup attributes attributes
+ * @defgroup attributes_g attributes
  * @{ @ingroup attributes
  */
 
index b97d78e..3841171 100644 (file)
@@ -200,4 +200,4 @@ struct key_encoding_t {
  */
 key_encoding_t *key_encoding_create();
 
-#endif /* KEY_ENCODING_ @}*/
+#endif /** KEY_ENCODING_H_ @}*/
index 3e8f786..d4517f2 100644 (file)
@@ -139,8 +139,8 @@ bool private_key_equals(private_key_t *this, private_key_t *other);
 /**
  * Generic private key belongs_to() implementation, usable by implementors.
  *
- * @param this                 first key to compare
- * @param other                        second key to compare
+ * @param private              private key to check
+ * @param public               public key to compare
  * @return                             TRUE if this is equal to other
  */
 bool private_key_belongs_to(private_key_t *private, public_key_t *public);
@@ -149,7 +149,7 @@ bool private_key_belongs_to(private_key_t *private, public_key_t *public);
  * Generic private key has_fingerprint() implementation, usable by implementors.
  *
  * @param this                 key to check fingerprint
- * @param fp                   fingerprint to check
+ * @param fingerprint  fingerprint to check
  * @return                             TRUE if key has given fingerprint
  */
 bool private_key_has_fingerprint(private_key_t *this, chunk_t fingerprint);
index 6a8560f..a421e7b 100644 (file)
@@ -198,7 +198,7 @@ bool public_key_equals(public_key_t *this, public_key_t *other);
  * Generic public key has_fingerprint() implementation, usable by implementors.
  *
  * @param this                 key to check fingerprint
- * @param fp                   fingerprint to check
+ * @param fingerprint  fingerprint to check
  * @return                             TRUE if key has given fingerprint
  */
 bool public_key_has_fingerprint(public_key_t *this, chunk_t fingerprint);
index ddab48d..ddcc2da 100644 (file)
@@ -202,4 +202,4 @@ struct crypto_tester_t {
  */
 crypto_tester_t *crypto_tester_create();
 
-#endif /* CRYPTO_TESTER_ @}*/
+#endif /** CRYPTO_TESTER_H_ @}*/
index 1449f97..9fa043c 100644 (file)
@@ -130,7 +130,7 @@ int hasher_algorithm_to_oid(hash_algorithm_t alg);
  * Conversion of hash signature algorithm into ASN.1 OID.
  *
  * @param alg                  hash algorithm
- * @param alg                  public key type
+ * @param key                  public key type
  * @return                             ASN.1 OID if, or OID_UNKNOW
  */
 int hasher_signature_algorithm_to_oid(hash_algorithm_t alg, key_type_t key);
index 332997b..7349353 100644 (file)
@@ -108,4 +108,4 @@ struct integrity_checker_t {
  */
 integrity_checker_t *integrity_checker_create(char *checksum_library);
 
-#endif /* INTEGRITY_CHECKER_H_ @}*/
+#endif /** INTEGRITY_CHECKER_H_ @}*/
index 3a7b842..3a60ea0 100644 (file)
  */
 
 /**
- * @defgroup sql sql
- * @ingroup cplugins
+ * @defgroup attr_sql attr_sql
+ * @ingroup plugins
  *
  * @defgroup sql_plugin sql_plugin
- * @{ @ingroup sql
+ * @{ @ingroup attr_sql
  */
 
 #ifndef ATTR_SQL_PLUGIN_H_
index 27a3965..ca87eb2 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup sql_attribute sql_attribute
- * @{ @ingroup sql
+ * @{ @ingroup attr_sql
  */
 
 #ifndef SQL_ATTRIBUTE_H_
index 7fb9a89..776be89 100644 (file)
@@ -44,4 +44,4 @@ struct padlock_rng_t {
  */
 padlock_rng_t *padlock_rng_create(rng_quality_t quality);
 
-#endif /** PADLOCK_RNG_ @}*/
+#endif /** PADLOCK_RNG_H_ @}*/
index cfff391..189a543 100644 (file)
@@ -45,7 +45,7 @@ private_key_t *pem_private_key_load(key_type_t type, va_list args);
 public_key_t *pem_public_key_load(key_type_t type, va_list args);
 
 /**
- * Build PEM encoded certificates..
+ * Build PEM encoded certificates.
  *
  * @param type         type of the certificate
  * @param args         builder_part_t argument list
index 938bbac..1168bab 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup pgp_public_key pgp_public_key
- * @{ @ingroup pgp_p
+ * @{ @ingroup pgp
  */
 
 #ifndef PGP_BUILDER_H_
index 7845e8f..4db795d 100644 (file)
@@ -45,4 +45,4 @@ struct pgp_cert_t {
  */
 pgp_cert_t *pgp_cert_load(certificate_type_t type, va_list args);
 
-#endif /* PGP_CERT_ @}*/
+#endif /** PGP_CERT_H_ @}*/
index 1b66969..9df1433 100644 (file)
@@ -29,4 +29,4 @@
 bool pgp_encoder_encode(key_encoding_type_t type, chunk_t *encoding,
                                                va_list args);
 
-#endif /* PGP_ENCODER_ @}*/
+#endif /** PGP_ENCODER_H_ @}*/
index 841de5d..95765cd 100644 (file)
  */
 
 /**
- * @defgroup pgp_p pgp
+ * @defgroup pgp pgp
  * @ingroup plugins
  *
  * @defgroup pgp_plugin pgp_plugin
- * @{ @ingroup pgp_p
+ * @{ @ingroup pgp
  */
 
 #ifndef PGP_PLUGIN_H_
index 93c51c4..203a0a8 100644 (file)
@@ -127,4 +127,4 @@ bool pgp_read_scalar(chunk_t *blob, size_t bytes, u_int32_t *scalar);
  */
 bool pgp_read_packet(chunk_t *blob, chunk_t *data, pgp_packet_tag_t *tag);
 
-#endif /* PGP_UTILS_ @}*/
+#endif /** PGP_UTILS_H_ @}*/
index a4a780b..62ca9f3 100644 (file)
@@ -15,7 +15,7 @@
 
 /**
  * @defgroup pkcs1_public_key pkcs1_public_key
- * @{ @ingroup pkcs1_p
+ * @{ @ingroup pkcs1
  */
 
 #ifndef PKCS1_BUILDER_H_
index c0bb688..11d9f27 100644 (file)
@@ -29,4 +29,4 @@
 bool pkcs1_encoder_encode(key_encoding_type_t type, chunk_t *encoding,
                                                  va_list args);
 
-#endif /* PKCS1_ENCODER_ @}*/
+#endif /** PKCS1_ENCODER_H_ @}*/
index 3b77de1..465c7ef 100644 (file)
  */
 
 /**
- * @defgroup pkcs1_p pkcs1
+ * @defgroup pkcs1 pkcs1
  * @ingroup plugins
  *
  * @defgroup pkcs1_plugin pkcs1_plugin
- * @{ @ingroup pkcs1_p
+ * @{ @ingroup pkcs1
  */
 
 #ifndef PKCS1_PLUGIN_H_
index 893ab52..01b103c 100644 (file)
@@ -36,4 +36,4 @@ bool get_form(char *form, key_encoding_type_t *type, bool pub);
  */
 hash_algorithm_t get_digest(char *name);
 
-#endif /* PKI_ @}*/
+#endif /** PKI_H_ @}*/