From 19f78a6fed6e966721e9e310099dbfa79489f9d9 Mon Sep 17 00:00:00 2001 From: Martin Willi Date: Thu, 15 Dec 2005 12:10:53 +0000 Subject: [PATCH] - fixed doxygen warnings --- Source/charon/config/sa_config.h | 52 +++++++++---------- Source/charon/config/traffic_selector.h | 4 +- Source/charon/definitions.h | 36 ++++++------- Source/charon/encoding/payloads/ts_payload.h | 11 ++-- .../queues/jobs/retransmit_request_job.h | 2 +- Source/charon/sa/ike_sa_id.h | 2 +- .../charon/sa/states/ike_sa_init_responded.h | 2 +- Source/charon/testcases/generator_test.h | 2 +- Source/charon/testcases/ike_sa_manager_test.h | 2 +- Source/charon/transforms/crypters/crypter.h | 4 +- Source/charon/transforms/hashers/hasher.h | 4 +- .../charon/transforms/rsa/rsa_private_key.h | 2 +- Source/charon/transforms/rsa/rsa_public_key.h | 2 +- .../charon/transforms/signers/hmac_signer.h | 2 +- Source/charon/utils/iterator.h | 4 +- 15 files changed, 67 insertions(+), 64 deletions(-) diff --git a/Source/charon/config/sa_config.h b/Source/charon/config/sa_config.h index a2cc3f897..ad9e33019 100644 --- a/Source/charon/config/sa_config.h +++ b/Source/charon/config/sa_config.h @@ -99,8 +99,8 @@ struct sa_config_t { * * Returned object is not getting cloned. * - * @param this calling object - * @return own id + * @param this calling object + * @return own id */ identification_t *(*get_my_id) (sa_config_t *this); @@ -109,23 +109,23 @@ struct sa_config_t { * * Returned object is not getting cloned. * - * @param this calling object - * @return other id + * @param this calling object + * @return other id */ identification_t *(*get_other_id) (sa_config_t *this); /** * @brief Get authentication method to use for IKE_AUTH. * - * @param this calling object - * @return authentication methood + * @param this calling object + * @return authentication methood */ auth_method_t (*get_auth_method) (sa_config_t *this); /** * @brief Get lifetime of IKE_SA in milliseconds. * - * @return IKE_SA lifetime in milliseconds. + * @return IKE_SA lifetime in milliseconds. */ u_int32_t (*get_ike_sa_lifetime) (sa_config_t *this); @@ -138,9 +138,9 @@ struct sa_config_t { * @warning Resulting pointer array must be freed! * @warning Traffic selectors in array must be destroyed! * - * @param this calling object - * @param[out]traffic_selectors pointer where traffic selectors will be allocated - * @return number of returned traffic selectors + * @param this calling object + * @param[out] traffic_selectors pointer where traffic selectors will be allocated + * @return number of returned traffic selectors */ size_t (*get_traffic_selectors_initiator) (sa_config_t *this, traffic_selector_t **traffic_selectors[]); @@ -154,9 +154,9 @@ struct sa_config_t { * @warning Resulting pointer array must be freed! * @warning Traffic selectors in array must be destroyed! * - * @param this calling object - * @param[out]traffic_selectors pointer where traffic selectors will be allocated - * @return number of returned traffic selectors + * @param this calling object + * @param[out] traffic_selectors pointer where traffic selectors will be allocated + * @return number of returned traffic selectors */ size_t (*get_traffic_selectors_responder) (sa_config_t *this, traffic_selector_t **traffic_selectors[]); @@ -169,11 +169,11 @@ struct sa_config_t { * @warning Resulting pointer array must be freed! * @warning Traffic selectors in array must be destroyed! * - * @param this calling object - * @param supplied pointer to an array of ts to select from. - * @param count number of ts stored at supplied - * @param[out]traffic_selectors pointer where selected traffic selectors will be allocated - * @return number of selected traffic selectors + * @param this calling object + * @param supplied pointer to an array of ts to select from. + * @param count number of ts stored at supplied + * @param[out] traffic_selectors pointer where selected traffic selectors will be allocated + * @return number of selected traffic selectors */ size_t (*select_traffic_selectors_initiator) (sa_config_t *this, traffic_selector_t *supplied[], size_t count, traffic_selector_t **selected[]); @@ -186,11 +186,11 @@ struct sa_config_t { * @warning Resulting pointer array must be freed! * @warning Traffic selectors in array must be destroyed! * - * @param this calling object - * @param supplied pointer to an array of ts to select from. - * @param count number of ts stored at supplied - * @param[out]traffic_selectors pointer where selected traffic selectors will be allocated - * @return number of selected traffic selectors + * @param this calling object + * @param supplied pointer to an array of ts to select from. + * @param count number of ts stored at supplied + * @param[out] traffic_selectors pointer where selected traffic selectors will be allocated + * @return number of selected traffic selectors */ size_t (*select_traffic_selectors_responder) (sa_config_t *this, traffic_selector_t *supplied[], size_t count, traffic_selector_t **selected[]); @@ -199,9 +199,9 @@ struct sa_config_t { * * @warning Resulting array must be freed! * - * @param this calling object - * @param[out]traffic_selectors pointer where proposals will be allocated - * @return number of allocated proposals + * @param this calling object + * @param[out] traffic_selectors pointer where proposals will be allocated + * @return number of allocated proposals */ size_t (*get_proposals) (sa_config_t *this, u_int8_t ah_spi[4], u_int8_t esp_spi[4], child_proposal_t *proposals[]); diff --git a/Source/charon/config/traffic_selector.h b/Source/charon/config/traffic_selector.h index 02d23f7f2..662795352 100644 --- a/Source/charon/config/traffic_selector.h +++ b/Source/charon/config/traffic_selector.h @@ -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 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 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 * @return * - traffic_selector_t object diff --git a/Source/charon/definitions.h b/Source/charon/definitions.h index 555c94fec..fe9a5ccbf 100644 --- a/Source/charon/definitions.h +++ b/Source/charon/definitions.h @@ -61,25 +61,25 @@ /** - * @defgroup config + * @defgroup config config * * Classes implementing configuration related things. */ /** - * @defgroup encoding + * @defgroup encoding encoding * * Classes used to encode and decode IKEv2 messages. */ /** - * @defgroup network + * @defgroup network network * * Classes for network relevant stuff. */ /** - * @defgroup payloads + * @defgroup payloads payloads * * Classes representing specific IKEv2 payloads. * @@ -87,14 +87,14 @@ */ /** - * @defgroup sa + * @defgroup sa sa * * Security association and helper classes. */ /** - * @defgroup states + * @defgroup states states * * Varius states in which an IKE SA can be. * @@ -102,13 +102,13 @@ */ /** - * @defgroup queues + * @defgroup queues queues * * Different kind of queues. */ /** - * @defgroup jobs + * @defgroup jobs jobs * * 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. */ /** - * @defgroup transforms + * @defgroup transforms transforms * * Transform algorithms of different kind. */ /** - * @defgroup rsa + * @defgroup rsa rsa * * RSA public key algorithm. * @@ -136,7 +136,7 @@ */ /** - * @defgroup prfs + * @defgroup prfs prfs * * Pseudo random functions. * @@ -144,7 +144,7 @@ */ /** - * @defgroup signers + * @defgroup signers signers * * 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. * @@ -160,21 +160,21 @@ */ /** - * @defgroup hashers + * @defgroup hashers hashers * * Hashing algorithms. * * @ingroup transforms */ - /** - * @defgroup utils +/** + * @defgroup utils utils * * Generic helper classes. */ /** - * @defgroup threads + * @defgroup threads threads * * Threaded classes, which will do their job alone. */ diff --git a/Source/charon/encoding/payloads/ts_payload.h b/Source/charon/encoding/payloads/ts_payload.h index 1b18d3646..f285612f7 100644 --- a/Source/charon/encoding/payloads/ts_payload.h +++ b/Source/charon/encoding/payloads/ts_payload.h @@ -107,7 +107,8 @@ struct ts_payload_t { * @brief Create an array of the nested traffic_selector_t's. * * @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[out] address of the array of traffic_selectors will be written here. @@ -141,9 +142,11 @@ ts_payload_t *ts_payload_create(bool is_initiator); * * * @param is_initiator - * - TRUE if this payload is of type TSi - * - FALSE if this payload is of type TSr - * @return ts_payload_t object + * - TRUE if this payload is of type TSi + * - 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 * * @ingroup payloads */ diff --git a/Source/charon/queues/jobs/retransmit_request_job.h b/Source/charon/queues/jobs/retransmit_request_job.h index b60852662..5c97ec65e 100644 --- a/Source/charon/queues/jobs/retransmit_request_job.h +++ b/Source/charon/queues/jobs/retransmit_request_job.h @@ -1,5 +1,5 @@ /** - * @file retransmit_request_job.c + * @file retransmit_request_job.h * * @brief Interface of retransmit_request_job_t. * diff --git a/Source/charon/sa/ike_sa_id.h b/Source/charon/sa/ike_sa_id.h index a39beadc0..aff710cc8 100644 --- a/Source/charon/sa/ike_sa_id.h +++ b/Source/charon/sa/ike_sa_id.h @@ -136,7 +136,7 @@ struct ike_sa_id_t { * * @param initiator_spi initiators 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 * * @ingroup sa diff --git a/Source/charon/sa/states/ike_sa_init_responded.h b/Source/charon/sa/states/ike_sa_init_responded.h index 2ac8d0744..43aecf26f 100644 --- a/Source/charon/sa/states/ike_sa_init_responded.h +++ b/Source/charon/sa/states/ike_sa_init_responded.h @@ -58,7 +58,7 @@ struct ike_sa_init_responded_t { * * @param ike_sa assigned IKE_SA * @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_response_data binary representation of sent IKE_SA_INIT response * diff --git a/Source/charon/testcases/generator_test.h b/Source/charon/testcases/generator_test.h index a71590847..204255fb7 100644 --- a/Source/charon/testcases/generator_test.h +++ b/Source/charon/testcases/generator_test.h @@ -1,5 +1,5 @@ /** - * @file generator.h + * @file generator_test.h * * @brief Tests for the generator_t class. * diff --git a/Source/charon/testcases/ike_sa_manager_test.h b/Source/charon/testcases/ike_sa_manager_test.h index b3e6ef935..c3e9f99f1 100644 --- a/Source/charon/testcases/ike_sa_manager_test.h +++ b/Source/charon/testcases/ike_sa_manager_test.h @@ -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. * diff --git a/Source/charon/transforms/crypters/crypter.h b/Source/charon/transforms/crypters/crypter.h index 00ed83ace..25a27e142 100644 --- a/Source/charon/transforms/crypters/crypter.h +++ b/Source/charon/transforms/crypters/crypter.h @@ -87,7 +87,7 @@ struct crypter_t { * @param this calling object * @param data data to encrypt * @param iv initializing vector - * @param [out]encrypted pointer where the encrypted bytes will be written + * @param[out] encrypted pointer where the encrypted bytes will be written * @return * - SUCCESS * - INVALID_ARG if data size not a multiple of block size @@ -101,7 +101,7 @@ struct crypter_t { * @param this calling object * @param data data to decrypt * @param iv initializing vector - * @param [out]encrypted pointer where the decrypted bytes will be written + * @param[out] encrypted pointer where the decrypted bytes will be written * @return * - SUCCESS * - INVALID_ARG if data size not a multiple of block size diff --git a/Source/charon/transforms/hashers/hasher.h b/Source/charon/transforms/hashers/hasher.h index 00ea0a724..a4d6f14d7 100644 --- a/Source/charon/transforms/hashers/hasher.h +++ b/Source/charon/transforms/hashers/hasher.h @@ -91,7 +91,7 @@ struct hasher_t { * * @param this calling object * @param data data to hash - * @param [out]hash pointer where the hash will be written + * @param[out] hash pointer where the hash will be written */ void (*get_hash) (hasher_t *this, chunk_t data, u_int8_t *hash); @@ -104,7 +104,7 @@ struct hasher_t { * * @param this calling object * @param data chunk with data to hash - * @param [out]hash chunk which will hold allocated hash + * @param[out] hash chunk which will hold allocated hash */ void (*allocate_hash) (hasher_t *this, chunk_t data, chunk_t *hash); diff --git a/Source/charon/transforms/rsa/rsa_private_key.h b/Source/charon/transforms/rsa/rsa_private_key.h index 2e24c34ec..094c3e249 100644 --- a/Source/charon/transforms/rsa/rsa_private_key.h +++ b/Source/charon/transforms/rsa/rsa_private_key.h @@ -48,7 +48,7 @@ typedef struct rsa_private_key_t 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 * it with an ASN1-OID of the hash algorithm and runs the RSASP1 function diff --git a/Source/charon/transforms/rsa/rsa_public_key.h b/Source/charon/transforms/rsa/rsa_public_key.h index 657f7f5a6..a4671b148 100644 --- a/Source/charon/transforms/rsa/rsa_public_key.h +++ b/Source/charon/transforms/rsa/rsa_public_key.h @@ -49,7 +49,7 @@ typedef struct rsa_public_key_t 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, * selects the hash algorithm form the resultign ASN1-OID and diff --git a/Source/charon/transforms/signers/hmac_signer.h b/Source/charon/transforms/signers/hmac_signer.h index 1ce23622d..8cbe80ecd 100644 --- a/Source/charon/transforms/signers/hmac_signer.h +++ b/Source/charon/transforms/signers/hmac_signer.h @@ -45,7 +45,7 @@ struct 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 * - hmac_signer_t * - NULL if hash algorithm not supported diff --git a/Source/charon/utils/iterator.h b/Source/charon/utils/iterator.h index 260a4712b..69ee828f4 100644 --- a/Source/charon/utils/iterator.h +++ b/Source/charon/utils/iterator.h @@ -68,7 +68,7 @@ struct iterator_t { 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 * @@ -93,7 +93,7 @@ struct iterator_t { * The iterator position is not changed after replacing. * * @param this calling iterator - * @param[out]old_item old value will be written here(can be NULL) + * @param[out] old_item old value will be written here(can be NULL) * @param[in] new_item new value * * @return