Fix various API doc issues and typos

Partially based on an old patch by Adrian-Ken Rueegsegger.
This commit is contained in:
Tobias Brunner
2013-07-18 18:30:36 +02:00
parent cb6c4e0430
commit 0ceb288815
26 changed files with 55 additions and 49 deletions
+5 -5
View File
@@ -213,14 +213,14 @@ struct child_cfg_t {
u_int32_t (*get_inactivity)(child_cfg_t *this);
/**
* Specific reqid to use for CHILD_SA
* Specific reqid to use for CHILD_SA.
*
* @return reqid
*/
u_int32_t (*get_reqid)(child_cfg_t *this);
/**
* Optional mark for CHILD_SA
* Optional mark for CHILD_SA.
*
* @param inbound TRUE for inbound, FALSE for outbound
* @return mark
@@ -235,7 +235,7 @@ struct child_cfg_t {
u_int32_t (*get_tfc)(child_cfg_t *this);
/**
* Sets two options needed for Mobile IPv6 interoperability
* Sets two options needed for Mobile IPv6 interoperability.
*
* @param proxy_mode use IPsec transport proxy mode (default FALSE)
* @param install_policy install IPsec kernel policies (default TRUE)
@@ -244,7 +244,7 @@ struct child_cfg_t {
bool install_policy);
/**
* Check whether IPsec transport SA should be set up in proxy mode
* Check whether IPsec transport SA should be set up in proxy mode.
*
* @return TRUE, if proxy mode should be used
* FALSE, otherwise
@@ -252,7 +252,7 @@ struct child_cfg_t {
bool (*use_proxy_mode)(child_cfg_t *this);
/**
* Check whether IPsec policies should be installed in the kernel
* Check whether IPsec policies should be installed in the kernel.
*
* @return TRUE, if IPsec kernel policies should be installed
* FALSE, otherwise
+2 -2
View File
@@ -176,7 +176,7 @@ struct peer_cfg_t {
/**
* Add an authentication config to the peer configuration.
*
* @param config config to add
* @param cfg config to add
* @param local TRUE for local rules, FALSE for remote constraints
*/
void (*add_auth_cfg)(peer_cfg_t *this, auth_cfg_t *cfg, bool local);
@@ -190,7 +190,7 @@ struct peer_cfg_t {
enumerator_t* (*create_auth_cfg_enumerator)(peer_cfg_t *this, bool local);
/**
* Should be sent a certificate for this connection?
* Should a certificate be sent for this connection?
*
* @return certificate sending policy
*/