Avoid problems with Doxygen by adding warn_unused_result attribute at the end of method signatures

This commit is contained in:
Tobias Brunner
2012-08-11 16:48:09 +02:00
parent 2c93a214aa
commit 3b891b9e5b
9 changed files with 57 additions and 61 deletions
+9 -9
View File
@@ -79,8 +79,8 @@ struct prf_t {
* @param buffer pointer where the generated bytes will be written
* @return TRUE if bytes generated successfully
*/
__attribute__((warn_unused_result))
bool (*get_bytes) (prf_t *this, chunk_t seed, u_int8_t *buffer);
bool (*get_bytes)(prf_t *this, chunk_t seed,
u_int8_t *buffer) __attribute__((warn_unused_result));
/**
* Generates pseudo random bytes and allocate space for them.
@@ -89,15 +89,15 @@ struct prf_t {
* @param chunk chunk which will hold generated bytes
* @return TRUE if bytes allocated and generated successfully
*/
__attribute__((warn_unused_result))
bool (*allocate_bytes) (prf_t *this, chunk_t seed, chunk_t *chunk);
bool (*allocate_bytes)(prf_t *this, chunk_t seed,
chunk_t *chunk) __attribute__((warn_unused_result));
/**
* Get the block size of this prf_t object.
*
* @return block size in bytes
*/
size_t (*get_block_size) (prf_t *this);
size_t (*get_block_size)(prf_t *this);
/**
* Get the key size of this prf_t object.
@@ -107,7 +107,7 @@ struct prf_t {
*
* @return key size in bytes
*/
size_t (*get_key_size) (prf_t *this);
size_t (*get_key_size)(prf_t *this);
/**
* Set the key for this prf_t object.
@@ -115,13 +115,13 @@ struct prf_t {
* @param key key to set
* @return TRUE if key set successfully
*/
__attribute__((warn_unused_result))
bool (*set_key) (prf_t *this, chunk_t key);
bool (*set_key)(prf_t *this,
chunk_t key) __attribute__((warn_unused_result));
/**
* Destroys a prf object.
*/
void (*destroy) (prf_t *this);
void (*destroy)(prf_t *this);
};
#endif /** PRF_H_ @}*/