diff options
Diffstat (limited to 'Source/charon/encoding/payloads')
10 files changed, 16 insertions, 6 deletions
diff --git a/Source/charon/encoding/payloads/auth_payload.h b/Source/charon/encoding/payloads/auth_payload.h index 3c02b2845..7be3859aa 100644 --- a/Source/charon/encoding/payloads/auth_payload.h +++ b/Source/charon/encoding/payloads/auth_payload.h @@ -72,7 +72,7 @@ extern mapping_t auth_method_m[]; typedef struct auth_payload_t auth_payload_t; /** - * @brief Object representing an IKEv2 AUTH payload. + * @brief Class representing an IKEv2 AUTH payload. * * The AUTH payload format is described in draft section 3.8. * diff --git a/Source/charon/encoding/payloads/cert_payload.h b/Source/charon/encoding/payloads/cert_payload.h index 8cbdf469c..8553e1a1d 100644 --- a/Source/charon/encoding/payloads/cert_payload.h +++ b/Source/charon/encoding/payloads/cert_payload.h @@ -67,7 +67,7 @@ extern mapping_t cert_encoding_m[]; typedef struct cert_payload_t cert_payload_t; /** - * Object representing an IKEv2 CERT payload. + * @brief Class representing an IKEv2 CERT payload. * * The CERT payload format is described in draft section 3.6. * This is just a dummy implementation to fullfill the standards @@ -77,6 +77,8 @@ typedef struct cert_payload_t cert_payload_t; * @b Constructors: * - cert_payload_create() * + * @todo Implement setters/getters for the different certificate encodings. + * * @ingroup payloads */ struct cert_payload_t { diff --git a/Source/charon/encoding/payloads/certreq_payload.h b/Source/charon/encoding/payloads/certreq_payload.h index 4be395922..055bfc79d 100644 --- a/Source/charon/encoding/payloads/certreq_payload.h +++ b/Source/charon/encoding/payloads/certreq_payload.h @@ -48,6 +48,8 @@ typedef struct certreq_payload_t certreq_payload_t; * @b Constructors: * - certreq_payload_create() * + * @todo Implement payload functionality. + * * @ingroup payloads */ struct certreq_payload_t { diff --git a/Source/charon/encoding/payloads/delete_payload.h b/Source/charon/encoding/payloads/delete_payload.h index 801c10444..522754c95 100644 --- a/Source/charon/encoding/payloads/delete_payload.h +++ b/Source/charon/encoding/payloads/delete_payload.h @@ -46,6 +46,8 @@ typedef struct delete_payload_t delete_payload_t; * @b Constructors: * - delete_payload_create() * + * @todo Implement better setter/getters + * * @ingroup payloads */ struct delete_payload_t { diff --git a/Source/charon/encoding/payloads/eap_payload.h b/Source/charon/encoding/payloads/eap_payload.h index e0e54b125..a934a1860 100644 --- a/Source/charon/encoding/payloads/eap_payload.h +++ b/Source/charon/encoding/payloads/eap_payload.h @@ -44,6 +44,8 @@ typedef struct eap_payload_t eap_payload_t; * @b Constructors: * - eap_payload_create() * + * @todo Implement functionality for this payload + * * @ingroup payloads */ struct eap_payload_t { diff --git a/Source/charon/encoding/payloads/encryption_payload.h b/Source/charon/encoding/payloads/encryption_payload.h index a54663417..7119a72a0 100644 --- a/Source/charon/encoding/payloads/encryption_payload.h +++ b/Source/charon/encoding/payloads/encryption_payload.h @@ -186,7 +186,7 @@ struct encryption_payload_t { /** * @brief Creates an empty encryption_payload_t object. * - * @returnencryption_payload_t object + * @return encryption_payload_t object * * @ingroup payloads */ diff --git a/Source/charon/encoding/payloads/notify_payload.h b/Source/charon/encoding/payloads/notify_payload.h index 9ece46151..40995c402 100644 --- a/Source/charon/encoding/payloads/notify_payload.h +++ b/Source/charon/encoding/payloads/notify_payload.h @@ -92,6 +92,8 @@ typedef struct notify_payload_t notify_payload_t; * @b Constructors: * - notify_payload_create() * - notify_payload_create_from_protocol_and_type() + * + * @todo Build specified constructor/getter for notify's * * @ingroup payloads */ diff --git a/Source/charon/encoding/payloads/proposal_substructure.h b/Source/charon/encoding/payloads/proposal_substructure.h index d7b9c7bd4..5380d1c65 100644 --- a/Source/charon/encoding/payloads/proposal_substructure.h +++ b/Source/charon/encoding/payloads/proposal_substructure.h @@ -61,7 +61,7 @@ extern mapping_t protocol_id_m[]; typedef struct proposal_substructure_t proposal_substructure_t; /** - * Object representing an IKEv2-PROPOSAL SUBSTRUCTURE. + * @brief Class representing an IKEv2-PROPOSAL SUBSTRUCTURE. * * The PROPOSAL SUBSTRUCTURE format is described in RFC section 3.3.1. * diff --git a/Source/charon/encoding/payloads/transform_attribute.h b/Source/charon/encoding/payloads/transform_attribute.h index 1bcc02db2..732edd023 100644 --- a/Source/charon/encoding/payloads/transform_attribute.h +++ b/Source/charon/encoding/payloads/transform_attribute.h @@ -49,7 +49,7 @@ extern mapping_t transform_attribute_type_m[]; typedef struct transform_attribute_t transform_attribute_t; /** - * Object representing an IKEv2- TRANSFORM Attribute. + * @brief Class representing an IKEv2- TRANSFORM Attribute. * * The TRANSFORM ATTRIBUTE format is described in RFC section 3.3.5. * diff --git a/Source/charon/encoding/payloads/transform_substructure.h b/Source/charon/encoding/payloads/transform_substructure.h index 4efb42f3f..cd5cffe7b 100644 --- a/Source/charon/encoding/payloads/transform_substructure.h +++ b/Source/charon/encoding/payloads/transform_substructure.h @@ -95,7 +95,7 @@ extern mapping_t extended_sequence_numbers_m[]; typedef struct transform_substructure_t transform_substructure_t; /** - * Object representing an IKEv2- TRANSFORM SUBSTRUCTURE. + * @brief Class representing an IKEv2- TRANSFORM SUBSTRUCTURE. * * The TRANSFORM SUBSTRUCTURE format is described in RFC section 3.3.2. * |