updated Doxyfile

properly close all doxygen groups fixed remaining doxygen warnings
2009-03-24 17:43:01 +00:00
parent e4838d02b3
commit 1490ff4d9b
296 changed files with 1703 additions and 510 deletions
@@ -47,4 +47,4 @@ struct aes_crypter_t {
 aes_crypter_t *aes_crypter_create(encryption_algorithm_t algo,
 								  size_t key_size);

-#endif /* AES_CRYPTER_H_ @}*/
+#endif /** AES_CRYPTER_H_ @}*/
@@ -44,4 +44,4 @@ struct aes_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* AES_PLUGIN_H_ @}*/
+#endif /** AES_PLUGIN_H_ @}*/
@@ -44,4 +44,4 @@ struct agent_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* AGENT_PLUGIN_H_ @}*/
+#endif /** AGENT_PLUGIN_H_ @}*/
@@ -44,5 +44,5 @@ struct agent_private_key_t {
 */
 builder_t *agent_private_key_builder(key_type_t type);

-#endif /*AGENT_PRIVATE_KEY_H_ @}*/
+#endif /** AGENT_PRIVATE_KEY_H_ @}*/

@@ -44,4 +44,4 @@ struct curl_fetcher_t {
 */
 curl_fetcher_t *curl_fetcher_create();

-#endif /* CURL_FETCHER_H_ @}*/
+#endif /** CURL_FETCHER_H_ @}*/
@@ -44,4 +44,4 @@ struct curl_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* CURL_PLUGIN_H_ @}*/
+#endif /** CURL_PLUGIN_H_ @}*/
@@ -46,4 +46,4 @@ struct des_crypter_t {
 des_crypter_t *des_crypter_create(encryption_algorithm_t algo);


-#endif /* DES_CRYPTER_H_ @}*/
+#endif /** DES_CRYPTER_H_ @}*/
@@ -44,4 +44,4 @@ struct des_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* DES_PLUGIN_H_ @}*/
+#endif /** DES_PLUGIN_H_ @}*/
@@ -56,4 +56,4 @@ struct fips_prf_t {
 */
 fips_prf_t *fips_prf_create(pseudo_random_function_t algo);

-#endif /* FIPS_PRF_H_ @}*/
+#endif /** FIPS_PRF_H_ @}*/
@@ -44,4 +44,4 @@ struct fips_prf_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* FIPS_PRF_PLUGIN_H_ @}*/
+#endif /** FIPS_PRF_PLUGIN_H_ @}*/
@@ -45,5 +45,5 @@ struct gmp_diffie_hellman_t {
 */
 gmp_diffie_hellman_t *gmp_diffie_hellman_create(diffie_hellman_group_t group);

-#endif /*GMP_DIFFIE_HELLMAN_H_ @}*/
+#endif /** GMP_DIFFIE_HELLMAN_H_ @}*/

@@ -44,4 +44,4 @@ struct gmp_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* GMP_PLUGIN_H_ @}*/
+#endif /** GMP_PLUGIN_H_ @}*/
@@ -44,5 +44,5 @@ struct gmp_rsa_private_key_t {
 */
 builder_t *gmp_rsa_private_key_builder(key_type_t type);

-#endif /*GMP_RSA_PRIVATE_KEY_H_ @}*/
+#endif /** GMP_RSA_PRIVATE_KEY_H_ @}*/

@@ -47,4 +47,4 @@ struct gmp_rsa_public_key_t {
 */
 builder_t *gmp_rsa_public_key_builder(key_type_t type);

-#endif /*GMP_RSA_PUBLIC_KEY_H_ @}*/
+#endif /** GMP_RSA_PUBLIC_KEY_H_ @}*/
@@ -90,4 +90,4 @@ struct hmac_t {
 */
 hmac_t *hmac_create(hash_algorithm_t hash_algorithm);

-#endif /*HMAC_H_ @}*/
+#endif /** HMAC_H_ @}*/
@@ -44,4 +44,4 @@ struct hmac_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* HMAC_PLUGIN_H_ @}*/
+#endif /** HMAC_PLUGIN_H_ @}*/
@@ -48,4 +48,4 @@ struct hmac_prf_t {
 */
 hmac_prf_t *hmac_prf_create(pseudo_random_function_t algo);

-#endif /*PRF_HMAC_SHA1_H_ @}*/
+#endif /** PRF_HMAC_SHA1_H_ @}*/
@@ -52,4 +52,4 @@ struct hmac_signer_t {
 */
 hmac_signer_t *hmac_signer_create(integrity_algorithm_t algo);

-#endif /*HMAC_SIGNER_H_ @}*/
+#endif /** HMAC_SIGNER_H_ @}*/
@@ -39,4 +39,4 @@ struct ldap_fetcher_t {
 */
 ldap_fetcher_t *ldap_fetcher_create();

-#endif /* LDAP_FETCHER_H_ @}*/
+#endif /** LDAP_FETCHER_H_ @}*/
@@ -44,4 +44,4 @@ struct ldap_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* LDAP_PLUGIN_H_ @}*/
+#endif /** LDAP_PLUGIN_H_ @}*/
@@ -45,4 +45,4 @@ struct md4_hasher_t {
 */
 md4_hasher_t *md4_hasher_create(hash_algorithm_t algo);

-#endif /*MD4_HASHER_H_@}*/
+#endif /** MD4_HASHER_H_ @}*/
@@ -44,4 +44,4 @@ struct md4_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* MD4_PLUGIN_H_ @}*/
+#endif /** MD4_PLUGIN_H_ @}*/
@@ -45,4 +45,4 @@ struct md5_hasher_t {
 */
 md5_hasher_t *md5_hasher_create(hash_algorithm_t algo);

-#endif /*MD5_HASHER_H_@}*/
+#endif /** MD5_HASHER_H_ @}*/
@@ -44,4 +44,4 @@ struct md5_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* MD5_PLUGIN_H_ @}*/
+#endif /** MD5_PLUGIN_H_ @}*/
@@ -39,7 +39,7 @@ struct mysql_database_t {
 /**
 * Create a mysql_database instance.
 *
- * @param uri			connection URI, mysql://user:pass@host:port/database
+ * @param uri			connection URI, mysql://user:pass@example.com:port/database
 */
 mysql_database_t *mysql_database_create(char *uri);

@@ -55,4 +55,4 @@ bool mysql_database_init();
 */
 void mysql_database_deinit();

-#endif /* MYSQL_DATABASE_H_ @}*/
+#endif /** MYSQL_DATABASE_H_ @}*/
@@ -44,4 +44,4 @@ struct mysql_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* MYSQL_PLUGIN_H_ @}*/
+#endif /** MYSQL_PLUGIN_H_ @}*/
@@ -48,4 +48,4 @@ struct openssl_crypter_t {
 openssl_crypter_t *openssl_crypter_create(encryption_algorithm_t algo,
 												  size_t key_size);

-#endif /* OPENSSL_CRYPTER_H_ @}*/
+#endif /** OPENSSL_CRYPTER_H_ @}*/
@@ -46,5 +46,5 @@ struct openssl_diffie_hellman_t {
 */
 openssl_diffie_hellman_t *openssl_diffie_hellman_create(diffie_hellman_group_t group);

-#endif /*OPENSSL_DIFFIE_HELLMAN_H_ @}*/
+#endif /** OPENSSL_DIFFIE_HELLMAN_H_ @}*/

@@ -46,5 +46,5 @@ struct openssl_ec_diffie_hellman_t {
 */
 openssl_ec_diffie_hellman_t *openssl_ec_diffie_hellman_create(diffie_hellman_group_t group);

-#endif /*OPENSSL_EC_DIFFIE_HELLMAN_H_ @}*/
+#endif /** OPENSSL_EC_DIFFIE_HELLMAN_H_ @}*/

@@ -46,4 +46,4 @@ struct openssl_ec_private_key_t {
 */
 builder_t *openssl_ec_private_key_builder(key_type_t type);

-#endif /*OPENSSL_EC_PRIVATE_KEY_H_ @}*/
+#endif /** OPENSSL_EC_PRIVATE_KEY_H_ @}*/
@@ -46,4 +46,4 @@ struct openssl_ec_public_key_t {
 */
 builder_t *openssl_ec_public_key_builder(key_type_t type);

-#endif /*OPENSSL_EC_PUBLIC_KEY_H_ @}*/
+#endif /** OPENSSL_EC_PUBLIC_KEY_H_ @}*/
@@ -42,9 +42,8 @@ struct openssl_hasher_t {
 * Constructor to create openssl_hasher_t.
 * 
 * @param algo			algorithm
- * @param key_size		key size in bytes
 * @return				openssl_hasher_t, NULL if not supported
 */
 openssl_hasher_t *openssl_hasher_create(hash_algorithm_t algo);

-#endif /* OPENSSL_HASHER_H_ @}*/
+#endif /** OPENSSL_HASHER_H_ @}*/
@@ -46,4 +46,4 @@ struct openssl_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* OPENSSL_PLUGIN_H_ @}*/
+#endif /** OPENSSL_PLUGIN_H_ @}*/
@@ -46,4 +46,4 @@ struct openssl_rsa_private_key_t {
 */
 builder_t *openssl_rsa_private_key_builder(key_type_t type);

-#endif /*OPENSSL_RSA_PRIVATE_KEY_H_ @}*/
+#endif /** OPENSSL_RSA_PRIVATE_KEY_H_ @}*/
@@ -46,4 +46,4 @@ struct openssl_rsa_public_key_t {
 */
 builder_t *openssl_rsa_public_key_builder(key_type_t type);

-#endif /*OPENSSL_RSA_PUBLIC_KEY_H_ @}*/
+#endif /** OPENSSL_RSA_PUBLIC_KEY_H_ @}*/
@@ -67,4 +67,4 @@ bool openssl_bn_cat(int len, BIGNUM *a, BIGNUM *b, chunk_t *chunk);
 */
 bool openssl_bn_split(chunk_t chunk, BIGNUM *a, BIGNUM *b);

-#endif /*OPENSSL_UTIL_H_ @}*/
+#endif /** OPENSSL_UTIL_H_ @}*/
@@ -47,4 +47,4 @@ struct padlock_aes_crypter_t {
 padlock_aes_crypter_t *padlock_aes_crypter_create(encryption_algorithm_t algo,
 												  size_t key_size);

-#endif /* PADLOCK_AES_CRYPTER_H_ @}*/
+#endif /** PADLOCK_AES_CRYPTER_H_ @}*/
@@ -44,4 +44,4 @@ struct padlock_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* PADLOCK_PLUGIN_H_ @}*/
+#endif /** PADLOCK_PLUGIN_H_ @}*/
@@ -17,7 +17,7 @@

 /**
 * @defgroup padlock_rng padlock_rng
- * @{ @ingroup padlock
+ * @{ @ingroup padlock_p
 */

 #ifndef PADLOCK_RNG_H_
@@ -46,4 +46,4 @@ struct padlock_rng_t {
 */
 padlock_rng_t *padlock_rng_create(rng_quality_t quality);

-#endif /* PADLOCK_RNG_ @}*/
+#endif /** PADLOCK_RNG_ @}*/
@@ -16,7 +16,7 @@

 /**
 * @defgroup sha1_hasher sha1_hasher
- * @{ @ingroup sha1_p
+ * @{ @ingroup padlock_p
 */

 #ifndef PADLOCK_SHA1_HASHER_H_
@@ -45,4 +45,4 @@ struct padlock_sha1_hasher_t {
 */
 padlock_sha1_hasher_t *padlock_sha1_hasher_create(hash_algorithm_t algo);

-#endif /*SHA1_HASHER_H_ @}*/
+#endif /** SHA1_HASHER_H_ @}*/
@@ -46,4 +46,4 @@ struct plugin_t {
 */
 typedef plugin_t *(*plugin_constructor_t)(void);

-#endif /* PLUGIN_H_ @}*/
+#endif /** PLUGIN_H_ @}*/
@@ -64,4 +64,4 @@ struct plugin_loader_t {
 */
 plugin_loader_t *plugin_loader_create();

-#endif /* PLUGIN_LOADER_H_ @}*/
+#endif /** PLUGIN_LOADER_H_ @}*/
@@ -48,4 +48,4 @@ struct pubkey_cert_t {
 */
 builder_t *pubkey_cert_builder(certificate_type_t type);

-#endif /* PUBKEY_CERT_H_ @}*/
+#endif /** PUBKEY_CERT_H_ @}*/
@@ -44,4 +44,4 @@ struct pubkey_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* PUBKEY_PLUGIN_H_ @}*/
+#endif /** PUBKEY_PLUGIN_H_ @}*/
@@ -33,4 +33,4 @@
 */
 builder_t *pubkey_public_key_builder(key_type_t type);

-#endif /*PUBKEY_RSA_PUBLIC_KEY_H_ @}*/
+#endif /** PUBKEY_RSA_PUBLIC_KEY_H_ @}*/
@@ -44,4 +44,4 @@ struct random_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* RANDOM_PLUGIN_H_ @}*/
+#endif /** RANDOM_PLUGIN_H_ @}*/
@@ -17,7 +17,7 @@
 
 /**
 * @defgroup random_rng random_rng
- * @{ @ingroup utils
+ * @{ @ingroup random_p
 */

 #ifndef RANDOM_RNG_H_
@@ -46,4 +46,4 @@ struct random_rng_t {
 */
 random_rng_t *random_rng_create(rng_quality_t quality);

-#endif /*RANDOM_RNG_H_ @} */
+#endif /** RANDOM_RNG_H_ @} */
@@ -45,4 +45,4 @@ struct sha1_hasher_t {
 */
 sha1_hasher_t *sha1_hasher_create(hash_algorithm_t algo);

-#endif /*SHA1_HASHER_H_ @}*/
+#endif /** SHA1_HASHER_H_ @}*/
@@ -44,4 +44,4 @@ struct sha1_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* SHA1_PLUGIN_H_ @}*/
+#endif /** SHA1_PLUGIN_H_ @}*/
@@ -44,4 +44,4 @@ struct sha1_prf_t {
 */
 sha1_prf_t *sha1_prf_create(pseudo_random_function_t algo);

-#endif /*SHA1_PRF_H_ @}*/
+#endif /** SHA1_PRF_H_ @}*/
@@ -47,4 +47,4 @@ struct sha2_hasher_t {
 */
 sha2_hasher_t *sha2_hasher_create(hash_algorithm_t algorithm);

-#endif /* SHA2_HASHER_H_ @}*/
+#endif /** SHA2_HASHER_H_ @}*/
@@ -44,4 +44,4 @@ struct sha2_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* SHA2_PLUGIN_H_ @}*/
+#endif /** SHA2_PLUGIN_H_ @}*/
@@ -43,4 +43,4 @@ struct sqlite_database_t {
 */
 sqlite_database_t *sqlite_database_create(char *uri);

-#endif /* SQLITE_DATABASE_H_ @}*/
+#endif /** SQLITE_DATABASE_H_ @}*/
@@ -44,4 +44,4 @@ struct sqlite_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* SQLITE_PLUGIN_H_ @}*/
+#endif /** SQLITE_PLUGIN_H_ @}*/
@@ -77,5 +77,5 @@ chunk_t ietfAttr_list_encode(linked_list_t *list);
 */
 void ietfAttr_list_destroy(linked_list_t *list);

-#endif /* IETF_ATTR_LIST_H_ @}*/
+#endif /** IETF_ATTR_LIST_H_ @}*/

@@ -56,4 +56,4 @@ struct x509_ac_t {
 */
 builder_t *x509_ac_builder(certificate_type_t type);

-#endif /* X509_AC_H_ @}*/
+#endif /** X509_AC_H_ @}*/
@@ -46,4 +46,4 @@ struct x509_cert_t {
 */
 builder_t *x509_cert_builder(certificate_type_t type);

-#endif /* X509_CERT_H_ @}*/
+#endif /** X509_CERT_H_ @}*/
@@ -45,4 +45,4 @@ struct x509_crl_t {
 */
 builder_t *x509_crl_builder(certificate_type_t type);

-#endif /* X509_CRL_H_ @}*/
+#endif /** X509_CRL_H_ @}*/
@@ -51,4 +51,4 @@ struct x509_ocsp_request_t {
 */
 builder_t *x509_ocsp_request_builder(certificate_type_t type);

-#endif /* X509_OCSP_REQUEST_H_ @}*/
+#endif /** X509_OCSP_REQUEST_H_ @}*/
@@ -44,4 +44,4 @@ struct x509_ocsp_response_t {
 */
 builder_t *x509_ocsp_response_builder(certificate_type_t type);

-#endif /* X509_OCSP_RESPONSE_H_ @}*/
+#endif /** X509_OCSP_RESPONSE_H_ @}*/
@@ -44,4 +44,4 @@ struct x509_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* X509_PLUGIN_H_ @}*/
+#endif /** X509_PLUGIN_H_ @}*/
@@ -75,4 +75,4 @@ struct xcbc_t {
 */
 xcbc_t *xcbc_create(encryption_algorithm_t algo, size_t key_size);

-#endif /*xcbc_H_ @}*/
+#endif /** XCBC_H_ @}*/
@@ -44,4 +44,4 @@ struct xcbc_plugin_t {
 */
 plugin_t *plugin_create();

-#endif /* XCBC_PLUGIN_H_ @}*/
+#endif /** XCBC_PLUGIN_H_ @}*/
@@ -47,4 +47,4 @@ struct xcbc_prf_t {
 */
 xcbc_prf_t *xcbc_prf_create(pseudo_random_function_t algo);

-#endif /*PRF_XCBC_SHA1_H_ @}*/
+#endif /** PRF_XCBC_SHA1_H_ @}*/
@@ -18,8 +18,8 @@
 * @{ @ingroup xcbc_p
 */

-#ifndef xcbc_SIGNER_H_
-#define xcbc_SIGNER_H_
+#ifndef XCBC_SIGNER_H_
+#define XCBC_SIGNER_H_

 typedef struct xcbc_signer_t xcbc_signer_t;

@@ -44,4 +44,4 @@ struct xcbc_signer_t {
 */
 xcbc_signer_t *xcbc_signer_create(integrity_algorithm_t algo);

-#endif /*xcbc_SIGNER_H_ @}*/
+#endif /** XCBC_SIGNER_H_ @}*/