Doxygen fixes

This commit is contained in:
Martin Willi
2012-03-20 17:31:25 +01:00
parent ef32c6866e
commit 8833068877
8 changed files with 8 additions and 5 deletions
@@ -96,7 +96,6 @@ struct cert_payload_t {
*/ */
char *(*get_url)(cert_payload_t *this); char *(*get_url)(cert_payload_t *this);
/** /**
* Destroys the cert_payload object. * Destroys the cert_payload object.
*/ */
@@ -107,7 +106,6 @@ struct cert_payload_t {
* Creates an empty certificate payload. * Creates an empty certificate payload.
* *
* @param type payload type (for IKEv1 or IKEv2) * @param type payload type (for IKEv1 or IKEv2)
* @param cert certificate to embed
* @return cert_payload_t object * @return cert_payload_t object
*/ */
cert_payload_t *cert_payload_create(payload_type_t type); cert_payload_t *cert_payload_create(payload_type_t type);
@@ -126,6 +124,7 @@ cert_payload_t *cert_payload_create_from_cert(payload_type_t type,
* Creates an IKEv2 certificate payload with hash and URL encoding. * Creates an IKEv2 certificate payload with hash and URL encoding.
* *
* @param hash hash of the DER encoded certificate (get's cloned) * @param hash hash of the DER encoded certificate (get's cloned)
* @param url URL to the certificate
* @return cert_payload_t object * @return cert_payload_t object
*/ */
cert_payload_t *cert_payload_create_from_hash_and_url(chunk_t hash, char *url); cert_payload_t *cert_payload_create_from_hash_and_url(chunk_t hash, char *url);
@@ -92,7 +92,7 @@ certreq_payload_t *certreq_payload_create_type(certificate_type_t type);
/** /**
* Creates a IKEv1 certreq_payload_t for a given distinguished name. * Creates a IKEv1 certreq_payload_t for a given distinguished name.
* *
* @param dn distinguished name, does not get owned * @param id distinguished name, does not get owned
* @return certreq payload * @return certreq payload
*/ */
certreq_payload_t *certreq_payload_create_dn(identification_t *id); certreq_payload_t *certreq_payload_create_dn(identification_t *id);
+1 -1
View File
@@ -73,7 +73,7 @@ struct id_payload_t {
* @param type one of ID_INITIATOR, ID_RESPONDER, ID_V1 and NAT_OA_V1 * @param type one of ID_INITIATOR, ID_RESPONDER, ID_V1 and NAT_OA_V1
* @return id_payload_t object * @return id_payload_t object
*/ */
id_payload_t *id_payload_create(payload_type_t payload_type); id_payload_t *id_payload_create(payload_type_t type);
/** /**
* Creates an id_payload_t from an existing identification_t object. * Creates an id_payload_t from an existing identification_t object.
@@ -272,7 +272,7 @@ notify_payload_t *notify_payload_create(payload_type_t type);
* *
* @param type payload type, NOTIFY or NOTIFY_V1 * @param type payload type, NOTIFY or NOTIFY_V1
* @param protocol protocol id (IKE, AH or ESP) * @param protocol protocol id (IKE, AH or ESP)
* @param type notify type (see notify_type_t) * @param notify type of notify
* @return notify_payload_t object * @return notify_payload_t object
*/ */
notify_payload_t *notify_payload_create_from_protocol_and_type( notify_payload_t *notify_payload_create_from_protocol_and_type(
@@ -40,6 +40,7 @@ struct pubkey_v1_authenticator_t {
* Create an authenticator to build and verify public key signatures. * Create an authenticator to build and verify public key signatures.
* *
* @param ike_sa associated IKE_SA * @param ike_sa associated IKE_SA
* @param initiator TRUE if we are IKE_SA initiator
* @param dh diffie hellman key exchange * @param dh diffie hellman key exchange
* @param dh_value others public diffie hellman value * @param dh_value others public diffie hellman value
* @param sa_payload generated SA payload data, without payload header * @param sa_payload generated SA payload data, without payload header
+1
View File
@@ -42,6 +42,7 @@ struct informational_t {
/** /**
* Create a new informational task. * Create a new informational task.
* *
* @param ike_sa IKE_SA this task works for
* @param notify notify to send as initiator, NULL if responder * @param notify notify to send as initiator, NULL if responder
* @return task to handle by the task_manager * @return task to handle by the task_manager
*/ */
+1
View File
@@ -41,6 +41,7 @@ struct main_mode_t {
/** /**
* Create a new main_mode task. * Create a new main_mode task.
* *
* @param ike_sa IKE_SA this task works for
* @param initiator TRUE if task initiated locally * @param initiator TRUE if task initiated locally
* @return task to handle by the task_manager * @return task to handle by the task_manager
*/ */
+1
View File
@@ -41,6 +41,7 @@ struct quick_mode_t {
/** /**
* Create a new quick_mode task. * Create a new quick_mode task.
* *
* @param ike_sa IKE_SA this task works for
* @param config child_cfg if task initiator, NULL if responder * @param config child_cfg if task initiator, NULL if responder
* @param tsi source of triggering packet, or NULL * @param tsi source of triggering packet, or NULL
* @param tsr destination of triggering packet, or NULL * @param tsr destination of triggering packet, or NULL