Doxygen fixes
authorMartin Willi <martin@revosec.ch>
Mon, 19 Dec 2011 09:27:40 +0000 (10:27 +0100)
committerMartin Willi <martin@revosec.ch>
Tue, 20 Mar 2012 16:31:25 +0000 (17:31 +0100)
src/libcharon/encoding/payloads/cert_payload.h
src/libcharon/encoding/payloads/certreq_payload.h
src/libcharon/encoding/payloads/id_payload.h
src/libcharon/encoding/payloads/notify_payload.h
src/libcharon/sa/authenticators/pubkey_v1_authenticator.h
src/libcharon/sa/tasks/informational.h
src/libcharon/sa/tasks/main_mode.h
src/libcharon/sa/tasks/quick_mode.h

index d85a463..19ed2cc 100644 (file)
@@ -96,7 +96,6 @@ struct cert_payload_t {
         */
        char *(*get_url)(cert_payload_t *this);
 
-
        /**
         * Destroys the cert_payload object.
         */
@@ -107,7 +106,6 @@ struct cert_payload_t {
  * Creates an empty certificate payload.
  *
  * @param type                         payload type (for IKEv1 or IKEv2)
- * @param cert                         certificate to embed
  * @return                                     cert_payload_t object
  */
 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.
  *
  * @param hash                         hash of the DER encoded certificate (get's cloned)
+ * @param url                          URL to the certificate
  * @return                                     cert_payload_t object
  */
 cert_payload_t *cert_payload_create_from_hash_and_url(chunk_t hash, char *url);
index e234df5..cce71c0 100644 (file)
@@ -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.
  *
- * @param dn                   distinguished name, does not get owned
+ * @param id                   distinguished name, does not get owned
  * @return                             certreq payload
  */
 certreq_payload_t *certreq_payload_create_dn(identification_t *id);
index 94ed1cb..9a62494 100644 (file)
@@ -73,7 +73,7 @@ struct id_payload_t {
  * @param type         one of ID_INITIATOR, ID_RESPONDER, ID_V1 and NAT_OA_V1
  * @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.
index 214a6b7..c6d09da 100644 (file)
@@ -272,7 +272,7 @@ notify_payload_t *notify_payload_create(payload_type_t type);
  *
  * @param type                                 payload type, NOTIFY or NOTIFY_V1
  * @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
  */
 notify_payload_t *notify_payload_create_from_protocol_and_type(
index 48968d6..e71a81f 100644 (file)
@@ -40,6 +40,7 @@ struct pubkey_v1_authenticator_t {
  * Create an authenticator to build and verify public key signatures.
  *
  * @param ike_sa                       associated IKE_SA
+ * @param initiator                    TRUE if we are IKE_SA initiator
  * @param dh                           diffie hellman key exchange
  * @param dh_value                     others public diffie hellman value
  * @param sa_payload           generated SA payload data, without payload header
index e9c32f6..2aec7ab 100644 (file)
@@ -42,6 +42,7 @@ struct informational_t {
 /**
  * Create a new informational task.
  *
+ * @param ike_sa               IKE_SA this task works for
  * @param notify               notify to send as initiator, NULL if responder
  * @return                             task to handle by the task_manager
  */
index d625011..9ff2530 100644 (file)
@@ -41,6 +41,7 @@ struct main_mode_t {
 /**
  * Create a new main_mode task.
  *
+ * @param ike_sa               IKE_SA this task works for
  * @param initiator            TRUE if task initiated locally
  * @return                             task to handle by the task_manager
  */
index 358296c..e50c1a9 100644 (file)
@@ -41,6 +41,7 @@ struct quick_mode_t {
 /**
  * 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 tsi                  source of triggering packet, or NULL
  * @param tsr                  destination of triggering packet, or NULL