- fixed doxygen warnings

This commit is contained in:
Martin Willi
2005-12-15 12:10:53 +00:00
parent b4ffed672b
commit 19f78a6fed
15 changed files with 67 additions and 64 deletions
+2 -2
View File
@@ -193,9 +193,9 @@ traffic_selector_t *traffic_selector_create_from_string(u_int8_t protocol, ts_ty
* *
* @param protocol protocol for this ts, such as TCP or UDP * @param protocol protocol for this ts, such as TCP or UDP
* @param type type of following addresses, such as TS_IPV4_ADDR_RANGE * @param type type of following addresses, such as TS_IPV4_ADDR_RANGE
* @param from_addr start of address range, network order * @param from_address start of address range, network order
* @param from_port port number, host order * @param from_port port number, host order
* @param to_addr end of address range as string, network * @param to_address end of address range as string, network
* @param to_port port number, host order * @param to_port port number, host order
* @return * @return
* - traffic_selector_t object * - traffic_selector_t object
+17 -17
View File
@@ -61,25 +61,25 @@
/** /**
* @defgroup config * @defgroup config config
* *
* Classes implementing configuration related things. * Classes implementing configuration related things.
*/ */
/** /**
* @defgroup encoding * @defgroup encoding encoding
* *
* Classes used to encode and decode IKEv2 messages. * Classes used to encode and decode IKEv2 messages.
*/ */
/** /**
* @defgroup network * @defgroup network network
* *
* Classes for network relevant stuff. * Classes for network relevant stuff.
*/ */
/** /**
* @defgroup payloads * @defgroup payloads payloads
* *
* Classes representing specific IKEv2 payloads. * Classes representing specific IKEv2 payloads.
* *
@@ -87,14 +87,14 @@
*/ */
/** /**
* @defgroup sa * @defgroup sa sa
* *
* Security association and helper classes. * Security association and helper classes.
*/ */
/** /**
* @defgroup states * @defgroup states states
* *
* Varius states in which an IKE SA can be. * Varius states in which an IKE SA can be.
* *
@@ -102,13 +102,13 @@
*/ */
/** /**
* @defgroup queues * @defgroup queues queues
* *
* Different kind of queues. * Different kind of queues.
*/ */
/** /**
* @defgroup jobs * @defgroup jobs jobs
* *
* Jobs used in job queue and event queue. * Jobs used in job queue and event queue.
* *
@@ -116,19 +116,19 @@
*/ */
/** /**
* @defgroup testcases * @defgroup testcases testcases
* *
* Testcases used to test the different classes in seperate module tests. * Testcases used to test the different classes in seperate module tests.
*/ */
/** /**
* @defgroup transforms * @defgroup transforms transforms
* *
* Transform algorithms of different kind. * Transform algorithms of different kind.
*/ */
/** /**
* @defgroup rsa * @defgroup rsa rsa
* *
* RSA public key algorithm. * RSA public key algorithm.
* *
@@ -136,7 +136,7 @@
*/ */
/** /**
* @defgroup prfs * @defgroup prfs prfs
* *
* Pseudo random functions. * Pseudo random functions.
* *
@@ -144,7 +144,7 @@
*/ */
/** /**
* @defgroup signers * @defgroup signers signers
* *
* Symmetric signing algorithms, used to ensure message integrity. * Symmetric signing algorithms, used to ensure message integrity.
* *
@@ -152,7 +152,7 @@
*/ */
/** /**
* @defgroup crypters * @defgroup crypters crypters
* *
* Symmetric encryption algorithms, used to encrypt and decrypt. * Symmetric encryption algorithms, used to encrypt and decrypt.
* *
@@ -160,7 +160,7 @@
*/ */
/** /**
* @defgroup hashers * @defgroup hashers hashers
* *
* Hashing algorithms. * Hashing algorithms.
* *
@@ -168,13 +168,13 @@
*/ */
/** /**
* @defgroup utils * @defgroup utils utils
* *
* Generic helper classes. * Generic helper classes.
*/ */
/** /**
* @defgroup threads * @defgroup threads threads
* *
* Threaded classes, which will do their job alone. * Threaded classes, which will do their job alone.
*/ */
+4 -1
View File
@@ -107,7 +107,8 @@ struct ts_payload_t {
* @brief Create an array of the nested traffic_selector_t's. * @brief Create an array of the nested traffic_selector_t's.
* *
* @warning Array must be freed after usage. * @warning Array must be freed after usage.
* @warnging traffic selector must be destroyed after usage. *
* @warning traffic selector must be destroyed after usage.
* *
* @param this calling ts_payload_t object * @param this calling ts_payload_t object
* @param[out] address of the array of traffic_selectors will be written here. * @param[out] address of the array of traffic_selectors will be written here.
@@ -143,6 +144,8 @@ ts_payload_t *ts_payload_create(bool is_initiator);
* @param is_initiator * @param is_initiator
* - TRUE if this payload is of type TSi * - TRUE if this payload is of type TSi
* - FALSE if this payload is of type TSr * - FALSE if this payload is of type TSr
* @param traffic_selectors an array of traffic_selector_t-pointers
* @param count number of pointers in the array
* @return ts_payload_t object * @return ts_payload_t object
* *
* @ingroup payloads * @ingroup payloads
@@ -1,5 +1,5 @@
/** /**
* @file retransmit_request_job.c * @file retransmit_request_job.h
* *
* @brief Interface of retransmit_request_job_t. * @brief Interface of retransmit_request_job_t.
* *
+1 -1
View File
@@ -136,7 +136,7 @@ struct ike_sa_id_t {
* *
* @param initiator_spi initiators SPI * @param initiator_spi initiators SPI
* @param responder_spi responders SPI * @param responder_spi responders SPI
* @param is_initiator TRUE if we are the original initiator * @param is_initiaor TRUE if we are the original initiator
* @return ike_sa_id_t object * @return ike_sa_id_t object
* *
* @ingroup sa * @ingroup sa
@@ -58,7 +58,7 @@ struct ike_sa_init_responded_t {
* *
* @param ike_sa assigned IKE_SA * @param ike_sa assigned IKE_SA
* @param received_nonce received nonce data in IKE_SA_INIT request * @param received_nonce received nonce data in IKE_SA_INIT request
* @param received_nonce sent nonce data in IKE_SA_INIT response * @param sent_nonce sent nonce data in IKE_SA_INIT response
* @param ike_sa_init_request_data binary representation of received IKE_SA_INIT request * @param ike_sa_init_request_data binary representation of received IKE_SA_INIT request
* @param ike_sa_init_response_data binary representation of sent IKE_SA_INIT response * @param ike_sa_init_response_data binary representation of sent IKE_SA_INIT response
* *
+1 -1
View File
@@ -1,5 +1,5 @@
/** /**
* @file generator.h * @file generator_test.h
* *
* @brief Tests for the generator_t class. * @brief Tests for the generator_t class.
* *
@@ -1,5 +1,5 @@
/** /**
* @file ike_sa_manager_test.c * @file ike_sa_manager_test.h
* *
* @brief Tests for the ike_sa_manager_t class. * @brief Tests for the ike_sa_manager_t class.
* *
@@ -48,7 +48,7 @@ typedef struct rsa_private_key_t rsa_private_key_t;
struct rsa_private_key_t { struct rsa_private_key_t {
/** /**
* @bief Build a signature over a chunk using EMSA-PKCS1 encoding. * @brief Build a signature over a chunk using EMSA-PKCS1 encoding.
* *
* This signature creates a hash using the specified hash algorithm, concatenates * This signature creates a hash using the specified hash algorithm, concatenates
* it with an ASN1-OID of the hash algorithm and runs the RSASP1 function * it with an ASN1-OID of the hash algorithm and runs the RSASP1 function
@@ -49,7 +49,7 @@ typedef struct rsa_public_key_t rsa_public_key_t;
struct rsa_public_key_t { struct rsa_public_key_t {
/** /**
* @bief Verify a EMSA-PKCS1 encodined signature. * @brief Verify a EMSA-PKCS1 encodined signature.
* *
* Processes the supplied signature with the RSAVP1 function, * Processes the supplied signature with the RSAVP1 function,
* selects the hash algorithm form the resultign ASN1-OID and * selects the hash algorithm form the resultign ASN1-OID and
@@ -45,7 +45,7 @@ struct hmac_signer_t {
/** /**
* @brief Creates a new hmac_signer_t. * @brief Creates a new hmac_signer_t.
* *
* @param hash_algorithm Hash algorithm to use with signer * @param hash_algoritm Hash algorithm to use with signer
* @return * @return
* - hmac_signer_t * - hmac_signer_t
* - NULL if hash algorithm not supported * - NULL if hash algorithm not supported
+1 -1
View File
@@ -68,7 +68,7 @@ struct iterator_t {
status_t (*current) (iterator_t *this, void **value); status_t (*current) (iterator_t *this, void **value);
/** /**
* @biref Inserts a new item before the given iterator position. * @brief Inserts a new item before the given iterator position.
* *
* The iterator position is not changed after inserting * The iterator position is not changed after inserting
* *