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
+10 -10
View File
@@ -93,8 +93,8 @@ struct signer_t {
* @param buffer pointer where the signature will be written
* @return TRUE if signature created successfully
*/
__attribute__((warn_unused_result))
bool (*get_signature) (signer_t *this, chunk_t data, u_int8_t *buffer);
bool (*get_signature)(signer_t *this, chunk_t data,
u_int8_t *buffer) __attribute__((warn_unused_result));
/**
* Generate a signature and allocate space for it.
@@ -106,8 +106,8 @@ struct signer_t {
* @param chunk chunk which will hold the allocated signature
* @return TRUE if signature allocated successfully
*/
__attribute__((warn_unused_result))
bool (*allocate_signature) (signer_t *this, chunk_t data, chunk_t *chunk);
bool (*allocate_signature)(signer_t *this, chunk_t data,
chunk_t *chunk) __attribute__((warn_unused_result));
/**
* Verify a signature.
@@ -120,21 +120,21 @@ struct signer_t {
* @param signature a chunk containing the signature
* @return TRUE, if signature is valid, FALSE otherwise
*/
bool (*verify_signature) (signer_t *this, chunk_t data, chunk_t signature);
bool (*verify_signature)(signer_t *this, chunk_t data, chunk_t signature);
/**
* Get the block size of this signature algorithm.
*
* @return block size in bytes
*/
size_t (*get_block_size) (signer_t *this);
size_t (*get_block_size)(signer_t *this);
/**
* Get the key size of the signature algorithm.
*
* @return key size in bytes
*/
size_t (*get_key_size) (signer_t *this);
size_t (*get_key_size)(signer_t *this);
/**
* Set the key for this object.
@@ -142,13 +142,13 @@ struct signer_t {
* @param key key to set
* @return TRUE if key set
*/
__attribute__((warn_unused_result))
bool (*set_key) (signer_t *this, chunk_t key);
bool (*set_key)(signer_t *this,
chunk_t key) __attribute__((warn_unused_result));
/**
* Destroys a signer_t object.
*/
void (*destroy) (signer_t *this);
void (*destroy)(signer_t *this);
};
#endif /** SIGNER_H_ @}*/