Avoid problems with Doxygen by adding warn_unused_result attribute at the end of...
authorTobias Brunner <tobias@strongswan.org>
Sat, 11 Aug 2012 14:48:09 +0000 (16:48 +0200)
committerTobias Brunner <tobias@strongswan.org>
Sat, 11 Aug 2012 14:48:09 +0000 (16:48 +0200)
src/libstrongswan/crypto/aead.h
src/libstrongswan/crypto/crypters/crypter.h
src/libstrongswan/crypto/hashers/hasher.h
src/libstrongswan/crypto/mac.h
src/libstrongswan/crypto/nonce_gen.h
src/libstrongswan/crypto/prf_plus.h
src/libstrongswan/crypto/prfs/prf.h
src/libstrongswan/crypto/rngs/rng.h
src/libstrongswan/crypto/signers/signer.h

index 522996e..ec526a3 100644 (file)
@@ -47,9 +47,8 @@ struct aead_t {
         * @param encrypted             allocated encryption result
         * @return                              TRUE if successfully encrypted
         */
-       __attribute__((warn_unused_result))
        bool (*encrypt)(aead_t *this, chunk_t plain, chunk_t assoc, chunk_t iv,
-                                       chunk_t *encrypted);
+                                       chunk_t *encrypted) __attribute__((warn_unused_result));
 
        /**
         * Decrypt and verify data, verify associated data.
@@ -102,8 +101,8 @@ struct aead_t {
         * @param key                   encryption and authentication key
         * @return                              TRUE if key set successfully
         */
-       __attribute__((warn_unused_result))
-       bool (*set_key)(aead_t *this, chunk_t key);
+       bool (*set_key)(aead_t *this,
+                                       chunk_t key) __attribute__((warn_unused_result));
 
        /**
         * Destroy a aead_t.
index 4c27305..fe854f5 100644 (file)
@@ -92,9 +92,8 @@ struct crypter_t {
         * @param encrypted             chunk to allocate encrypted data, or NULL
         * @return                              TRUE if encryption successful
         */
-       __attribute__((warn_unused_result))
-       bool (*encrypt) (crypter_t *this, chunk_t data, chunk_t iv,
-                                        chunk_t *encrypted);
+       bool (*encrypt)(crypter_t *this, chunk_t data, chunk_t iv,
+                                       chunk_t *encrypted) __attribute__((warn_unused_result));
 
        /**
         * Decrypt a chunk of data and allocate space for the decrypted value.
@@ -108,9 +107,8 @@ struct crypter_t {
         * @param encrypted             chunk to allocate decrypted data, or NULL
         * @return                              TRUE if decryption successful
         */
-       __attribute__((warn_unused_result))
-       bool (*decrypt) (crypter_t *this, chunk_t data, chunk_t iv,
-                                        chunk_t *decrypted);
+       bool (*decrypt)(crypter_t *this, chunk_t data, chunk_t iv,
+                                       chunk_t *decrypted) __attribute__((warn_unused_result));
 
        /**
         * Get the block size of the crypto algorithm.
@@ -121,7 +119,7 @@ struct crypter_t {
         *
         * @return                              block size in bytes
         */
-       size_t (*get_block_size) (crypter_t *this);
+       size_t (*get_block_size)(crypter_t *this);
 
        /**
         * Get the IV size of the crypto algorithm.
@@ -139,7 +137,7 @@ struct crypter_t {
         *
         * @return                              key size in bytes
         */
-       size_t (*get_key_size) (crypter_t *this);
+       size_t (*get_key_size)(crypter_t *this);
 
        /**
         * Set the key.
@@ -149,13 +147,13 @@ struct crypter_t {
         * @param key                   key to set
         * @return                              TRUE if key set successfully
         */
-       __attribute__((warn_unused_result))
-       bool (*set_key) (crypter_t *this, chunk_t key);
+       bool (*set_key)(crypter_t *this,
+                                       chunk_t key) __attribute__((warn_unused_result));
 
        /**
         * Destroys a crypter_t object.
         */
-       void (*destroy) (crypter_t *this);
+       void (*destroy)(crypter_t *this);
 };
 
 /**
index fa5ff69..759f6a2 100644 (file)
@@ -87,8 +87,8 @@ struct hasher_t {
         * @param hash          pointer where the hash will be written
         * @return                      TRUE if hash created successfully
         */
-       __attribute__((warn_unused_result))
-       bool (*get_hash) (hasher_t *this, chunk_t data, u_int8_t *hash);
+       bool (*get_hash)(hasher_t *this, chunk_t data,
+                                        u_int8_t *hash) __attribute__((warn_unused_result));
 
        /**
         * Hash data and allocate space for the hash.
@@ -101,28 +101,27 @@ struct hasher_t {
         * @param hash          chunk which will hold allocated hash
         * @return                      TRUE if hash allocated successfully
         */
-       __attribute__((warn_unused_result))
-       bool (*allocate_hash) (hasher_t *this, chunk_t data, chunk_t *hash);
+       bool (*allocate_hash)(hasher_t *this, chunk_t data,
+                                                 chunk_t *hash) __attribute__((warn_unused_result));
 
        /**
         * Get the size of the resulting hash.
         *
         * @return                      hash size in bytes
         */
-       size_t (*get_hash_size) (hasher_t *this);
+       size_t (*get_hash_size)(hasher_t *this);
 
        /**
         * Resets the hasher's state.
         *
         * @return                      TRUE if hasher reset successfully
         */
-       __attribute__((warn_unused_result))
-       bool (*reset) (hasher_t *this);
+       bool (*reset)(hasher_t *this) __attribute__((warn_unused_result));
 
        /**
         * Destroys a hasher object.
         */
-       void (*destroy) (hasher_t *this);
+       void (*destroy)(hasher_t *this);
 };
 
 /**
index 4f952a2..f7b43ba 100644 (file)
@@ -46,8 +46,8 @@ struct mac_t {
         * @param out           pointer where the generated bytes will be written
         * @return                      TRUE if mac generated successfully
         */
-       __attribute__((warn_unused_result))
-       bool (*get_mac)(mac_t *this, chunk_t data, u_int8_t *out);
+       bool (*get_mac)(mac_t *this, chunk_t data,
+                                       u_int8_t *out) __attribute__((warn_unused_result));
 
        /**
         * Get the size of the resulting MAC.
@@ -64,8 +64,8 @@ struct mac_t {
         * @param key           key to set
         * @return                      TRUE if key set successfully
         */
-       __attribute__((warn_unused_result))
-       bool (*set_key) (mac_t *this, chunk_t key);
+       bool (*set_key)(mac_t *this,
+                                       chunk_t key) __attribute__((warn_unused_result));
 
        /**
         * Destroys a mac_t object.
index 8461c4a..50f3c00 100644 (file)
@@ -37,8 +37,8 @@ struct nonce_gen_t {
         * @param buffer        pointer where the generated nonce will be written
         * @return                      TRUE if nonce allocation was succesful, FALSE otherwise
         */
-       __attribute__((warn_unused_result))
-       bool (*get_nonce) (nonce_gen_t *this, size_t size, u_int8_t *buffer);
+       bool (*get_nonce)(nonce_gen_t *this, size_t size,
+                                         u_int8_t *buffer) __attribute__((warn_unused_result));
 
        /**
         * Generates a nonce and allocates space for it.
@@ -47,13 +47,13 @@ struct nonce_gen_t {
         * @param chunk         chunk which will hold the generated nonce
         * @return                      TRUE if nonce allocation was succesful, FALSE otherwise
         */
-       __attribute__((warn_unused_result))
-       bool (*allocate_nonce) (nonce_gen_t *this, size_t size, chunk_t *chunk);
+       bool (*allocate_nonce)(nonce_gen_t *this, size_t size,
+                                                  chunk_t *chunk) __attribute__((warn_unused_result));
 
        /**
         * Destroys a nonce generator object.
         */
-       void (*destroy) (nonce_gen_t *this);
+       void (*destroy)(nonce_gen_t *this);
 };
 
 #endif /** NONCE_GEN_H_ @}*/
index 92f5dd7..f994dce 100644 (file)
@@ -38,8 +38,8 @@ struct prf_plus_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_plus_t *this, size_t length, u_int8_t *buffer);
+       bool (*get_bytes)(prf_plus_t *this, size_t length,
+                                         u_int8_t *buffer) __attribute__((warn_unused_result));
 
        /**
         * Allocate pseudo random bytes.
@@ -48,13 +48,13 @@ struct prf_plus_t {
         * @param chunk         chunk which will hold generated bytes
         * @return                      TRUE if bytes allocated successfully
         */
-       __attribute__((warn_unused_result))
-       bool (*allocate_bytes) (prf_plus_t *this, size_t length, chunk_t *chunk);
+       bool (*allocate_bytes)(prf_plus_t *this, size_t length,
+                                                  chunk_t *chunk) __attribute__((warn_unused_result));
 
        /**
         * Destroys a prf_plus_t object.
         */
-       void (*destroy) (prf_plus_t *this);
+       void (*destroy)(prf_plus_t *this);
 };
 
 /**
index a360a96..46e23b2 100644 (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_ @}*/
index 4a1a285..aee829d 100644 (file)
@@ -56,8 +56,8 @@ struct rng_t {
         * @param buffer        pointer where the generated bytes will be written
         * @return                      TRUE if bytes successfully written
         */
-       __attribute__((warn_unused_result))
-       bool (*get_bytes) (rng_t *this, size_t len, u_int8_t *buffer);
+       bool (*get_bytes)(rng_t *this, size_t len,
+                                         u_int8_t *buffer) __attribute__((warn_unused_result));
 
        /**
         * Generates random bytes and allocate space for them.
@@ -66,13 +66,13 @@ struct rng_t {
         * @param chunk         chunk which will hold generated bytes
         * @return                      TRUE if allocation succeeded
         */
-       __attribute__((warn_unused_result))
-       bool (*allocate_bytes) (rng_t *this, size_t len, chunk_t *chunk);
+       bool (*allocate_bytes)(rng_t *this, size_t len,
+                                                  chunk_t *chunk) __attribute__((warn_unused_result));
 
        /**
         * Destroys a rng object.
         */
-       void (*destroy) (rng_t *this);
+       void (*destroy)(rng_t *this);
 };
 
 /**
index 812a674..9b6bd47 100644 (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_ @}*/