Fix various API doc issues and typos
Partially based on an old patch by Adrian-Ken Rueegsegger.
This commit is contained in:
@@ -28,7 +28,7 @@
|
||||
*
|
||||
* An array is a primitive object with associated functions to avoid the
|
||||
* overhead of an object with methods. It is efficient in memory usage, but
|
||||
* less effecient than a linked list in manipulating elements.
|
||||
* less efficient than a linked list in manipulating elements.
|
||||
*/
|
||||
typedef struct array_t array_t;
|
||||
|
||||
@@ -140,11 +140,12 @@ void array_insert_create(array_t **array, int idx, void *ptr);
|
||||
void array_insert_enumerator(array_t *array, int idx, enumerator_t *enumerator);
|
||||
|
||||
/**
|
||||
* Remove an element from the array end.
|
||||
* Remove an element from the array.
|
||||
*
|
||||
* If data is given, the element is copied to that position.
|
||||
*
|
||||
* @param array array to remove element from, or NULL
|
||||
* @param idx index of the item to remove
|
||||
* @param data data to copy element to, or NULL
|
||||
* @return TRUE if idx existed and item removed
|
||||
*/
|
||||
|
||||
@@ -192,7 +192,7 @@ struct public_key_t {
|
||||
/**
|
||||
* Get the key in an encoded form as a chunk.
|
||||
*
|
||||
* @param type type of the encoding, one of PRIVKEY_*
|
||||
* @param type type of the encoding, one of PUBKEY_*
|
||||
* @param encoding encoding of the key, allocated
|
||||
* @return TRUE if encoding supported
|
||||
*/
|
||||
|
||||
@@ -58,7 +58,7 @@ struct aead_t {
|
||||
* is returned in the encrypted chunk, the last get_icv_size() bytes
|
||||
* contain the verified ICV.
|
||||
*
|
||||
* @param encrypted data to encrypt and verify
|
||||
* @param encrypted data to decrypt and verify
|
||||
* @param assoc associated data to verify
|
||||
* @param iv initialization vector
|
||||
* @param plain allocated result, if successful
|
||||
@@ -105,7 +105,7 @@ struct aead_t {
|
||||
chunk_t key) __attribute__((warn_unused_result));
|
||||
|
||||
/**
|
||||
* Destroy a aead_t.
|
||||
* Destroy an aead_t.
|
||||
*/
|
||||
void (*destroy)(aead_t *this);
|
||||
};
|
||||
|
||||
@@ -92,7 +92,7 @@ struct host_t {
|
||||
*
|
||||
* Returned chunk points to internal data.
|
||||
*
|
||||
* @return address string,
|
||||
* @return address blob
|
||||
*/
|
||||
chunk_t (*get_address) (host_t *this);
|
||||
|
||||
@@ -106,7 +106,7 @@ struct host_t {
|
||||
/**
|
||||
* Set the port of this host
|
||||
*
|
||||
* @param port port numer
|
||||
* @param port port number
|
||||
*/
|
||||
void (*set_port) (host_t *this, u_int16_t port);
|
||||
|
||||
@@ -194,6 +194,7 @@ host_t *host_create_from_subnet(char *string, int *bits);
|
||||
/**
|
||||
* Create a netmask host having the first netbits bits set.
|
||||
*
|
||||
* @param family family of the netmask host
|
||||
* @param netbits number of leading bits set in the host
|
||||
* @return netmask host
|
||||
*/
|
||||
|
||||
@@ -41,7 +41,7 @@ typedef enum watcher_event_t watcher_event_t;
|
||||
* and handle EAGAIN/EWOULDBLOCK gracefully.
|
||||
*
|
||||
* @param data user data passed during registration
|
||||
* @param fd file descriptor the event occured on
|
||||
* @param fd file descriptor the event occurred on
|
||||
* @param event type of event
|
||||
* @return TRUE to keep watching event, FALSE to unregister fd for event
|
||||
*/
|
||||
|
||||
@@ -241,7 +241,6 @@ struct identification_t {
|
||||
* no match at all, 1 means a bad match, and 2 a slightly better match.
|
||||
*
|
||||
* @param other the ID containing one or more wildcards
|
||||
* @param wildcards returns the number of wildcards, may be NULL
|
||||
* @return match value as described above
|
||||
*/
|
||||
id_match_t (*matches) (identification_t *this, identification_t *other);
|
||||
|
||||
Reference in New Issue
Block a user