Fix various API doc issues and typos
Partially based on an old patch by Adrian-Ken Rueegsegger.
This commit is contained in:
@@ -231,7 +231,7 @@ struct child_sa_t {
|
||||
/**
|
||||
* Override the DPD action specified by the CHILD_SA config.
|
||||
*
|
||||
* @param close action to enforce
|
||||
* @param dpd action to enforce
|
||||
*/
|
||||
void (*set_dpd_action)(child_sa_t *this, action_t action);
|
||||
|
||||
@@ -353,7 +353,7 @@ struct child_sa_t {
|
||||
* @param me the new local host
|
||||
* @param other the new remote host
|
||||
* @param vips list of local virtual IPs
|
||||
* @param TRUE to use UDP encapsulation for NAT traversal
|
||||
* @param encap TRUE to use UDP encapsulation for NAT traversal
|
||||
* @return SUCCESS or FAILED
|
||||
*/
|
||||
status_t (*update)(child_sa_t *this, host_t *me, host_t *other,
|
||||
|
||||
@@ -200,11 +200,11 @@ enum ike_condition_t {
|
||||
enum statistic_t {
|
||||
/** Timestamp of SA establishement */
|
||||
STAT_ESTABLISHED = 0,
|
||||
/** Timestamp of scheudled rekeying */
|
||||
/** Timestamp of scheduled rekeying */
|
||||
STAT_REKEY,
|
||||
/** Timestamp of scheudled reauthentication */
|
||||
/** Timestamp of scheduled reauthentication */
|
||||
STAT_REAUTH,
|
||||
/** Timestamp of scheudled delete */
|
||||
/** Timestamp of scheduled delete */
|
||||
STAT_DELETE,
|
||||
/** Timestamp of last inbound IKE packet */
|
||||
STAT_INBOUND,
|
||||
@@ -812,10 +812,8 @@ struct ike_sa_t {
|
||||
/**
|
||||
* Sends a keep alive packet.
|
||||
*
|
||||
* To refresh NAT tables in a NAT router
|
||||
* between the peers, periodic empty
|
||||
* UDP packets are sent if no other traffic
|
||||
* was sent.
|
||||
* To refresh NAT tables in a NAT router between the peers, periodic empty
|
||||
* UDP packets are sent if no other traffic was sent.
|
||||
*/
|
||||
void (*send_keepalive) (ike_sa_t *this);
|
||||
|
||||
|
||||
@@ -86,7 +86,7 @@ struct ike_sa_id_t {
|
||||
bool (*equals) (ike_sa_id_t *this, ike_sa_id_t *other);
|
||||
|
||||
/**
|
||||
* Replace all values of a given ike_sa_id_t object with values.
|
||||
* Replace all values of a given ike_sa_id_t object with values
|
||||
* from another ike_sa_id_t object.
|
||||
*
|
||||
* After calling this function, both objects are equal.
|
||||
|
||||
@@ -28,7 +28,7 @@ typedef struct ike_cert_pre_t ike_cert_pre_t;
|
||||
#include <sa/task.h>
|
||||
|
||||
/**
|
||||
* Task of type ike_cert_post, certificate processing before authentication.
|
||||
* Task of type ike_cert_pre, certificate processing before authentication.
|
||||
*/
|
||||
struct ike_cert_pre_t {
|
||||
|
||||
|
||||
@@ -79,7 +79,7 @@ struct keymat_t {
|
||||
*/
|
||||
nonce_gen_t* (*create_nonce_gen)(keymat_t *this);
|
||||
|
||||
/*
|
||||
/**
|
||||
* Get a AEAD transform to en-/decrypt and sign/verify IKE messages.
|
||||
*
|
||||
* @param in TRUE for inbound (decrypt), FALSE for outbound (encrypt)
|
||||
|
||||
@@ -67,7 +67,7 @@ enum task_type_t {
|
||||
TASK_CHILD_CREATE,
|
||||
/** delete an established CHILD_SA */
|
||||
TASK_CHILD_DELETE,
|
||||
/** rekey an CHILD_SA */
|
||||
/** rekey a CHILD_SA */
|
||||
TASK_CHILD_REKEY,
|
||||
/** IKEv1 main mode */
|
||||
TASK_MAIN_MODE,
|
||||
|
||||
Reference in New Issue
Block a user