Replace "@return a blah" and "@return the blah" with just "@return blah"

5 files changed, 31 insertions, 31 deletions

diff --git a/src/libstate/libstate.h b/src/libstate/libstate.h
index d7fb6e02c..eeb38287a 100644
--- a/src/libstate/libstate.h
+++ b/src/libstate/libstate.h
@@ -35,12 +35,12 @@ class BOTAN_DLL Library_State
       void initialize(bool thread_safe);
 
       /**
-      * @return the global Algorithm_Factory
+      * @return global Algorithm_Factory
       */
       Algorithm_Factory& algorithm_factory() const;
 
       /**
-      * @return the global RandomNumberGenerator
+      * @return global RandomNumberGenerator
       */
       RandomNumberGenerator& global_rng();
 
@@ -111,7 +111,7 @@ class BOTAN_DLL Library_State
       std::string deref_alias(const std::string& alias) const;
 
       /**
-      * @return a newly created Mutex (free with delete)
+      * @return newly created Mutex (free with delete)
       */
       Mutex* get_mutex() const;
    private:
@@ -155,7 +155,7 @@ BOTAN_DLL void set_global_state(Library_State* state);
 /**
 * Swap the current state for another
 * @param new_state the new state object to use
-* @return the previous state (or NULL if none)
+* @return previous state (or NULL if none)
 */
 BOTAN_DLL Library_State* swap_global_state(Library_State* new_state);
 
diff --git a/src/libstate/look_pk.h b/src/libstate/look_pk.h
index e1dc1d95c..c980e5f8d 100644
--- a/src/libstate/look_pk.h
+++ b/src/libstate/look_pk.h
@@ -19,7 +19,7 @@ namespace Botan {
 *
 * @param key the key that will work inside the encryptor
 * @param eme determines the algorithm and encoding
-* @return the public key encryptor object
+* @return public key encryptor object
 */
 inline PK_Encryptor* get_pk_encryptor(const Public_Key& key,
                                       const std::string& eme)
@@ -33,7 +33,7 @@ inline PK_Encryptor* get_pk_encryptor(const Public_Key& key,
 *
 * @param key the key that will work inside the decryptor
 * @param eme determines the algorithm and encoding
-* @return the public key decryptor object
+* @return public key decryptor object
 */
 inline PK_Decryptor* get_pk_decryptor(const Private_Key& key,
                                       const std::string& eme)
@@ -48,7 +48,7 @@ inline PK_Decryptor* get_pk_decryptor(const Private_Key& key,
 * @param key the key that will work inside the signer
 * @param emsa determines the algorithm, encoding and hash algorithm
 * @param sig_format the signature format to be used
-* @return the public key signer object
+* @return public key signer object
 */
 inline PK_Signer* get_pk_signer(const Private_Key& key,
                                 const std::string& emsa,
@@ -64,7 +64,7 @@ inline PK_Signer* get_pk_signer(const Private_Key& key,
 * @param key the key that will work inside the verifier
 * @param emsa determines the algorithm, encoding and hash algorithm
 * @param sig_format the signature format to be used
-* @return the public key verifier object
+* @return public key verifier object
 */
 inline PK_Verifier* get_pk_verifier(const Public_Key& key,
                                     const std::string& emsa,
@@ -79,7 +79,7 @@ inline PK_Verifier* get_pk_verifier(const Public_Key& key,
 *
 * @param key the key that will work inside the key agreement
 * @param kdf the kdf algorithm to use
-* @return the key agreement algorithm
+* @return key agreement algorithm
 */
 inline PK_Key_Agreement* get_pk_kas(const PK_Key_Agreement_Key& key,
                                        const std::string& kdf)
diff --git a/src/libstate/lookup.h b/src/libstate/lookup.h
index aa3a65f96..76e06b2de 100644
--- a/src/libstate/lookup.h
+++ b/src/libstate/lookup.h
@@ -64,7 +64,7 @@ retrieve_mac(const std::string& algo_spec)
 * @deprecated Call algorithm_factory() directly
 *
 * @param algo_spec the name of the desired block cipher
-* @return a pointer to the block cipher object
+* @return pointer to the block cipher object
 */
 inline BlockCipher* get_block_cipher(const std::string& algo_spec)
    {
@@ -77,7 +77,7 @@ inline BlockCipher* get_block_cipher(const std::string& algo_spec)
 * @deprecated Call algorithm_factory() directly
 *
 * @param algo_spec the name of the desired stream cipher
-* @return a pointer to the stream cipher object
+* @return pointer to the stream cipher object
 */
 inline StreamCipher* get_stream_cipher(const std::string& algo_spec)
    {
@@ -90,7 +90,7 @@ inline StreamCipher* get_stream_cipher(const std::string& algo_spec)
 * @deprecated Call algorithm_factory() directly
 *
 * @param algo_spec the name of the desired hash function
-* @return a pointer to the hash function object
+* @return pointer to the hash function object
 */
 inline HashFunction* get_hash(const std::string& algo_spec)
    {
@@ -103,7 +103,7 @@ inline HashFunction* get_hash(const std::string& algo_spec)
 * @deprecated Call algorithm_factory() directly
 *
 * @param algo_spec the name of the desired MAC
-* @return a pointer to the MAC object
+* @return pointer to the MAC object
 */
 inline MessageAuthenticationCode* get_mac(const std::string& algo_spec)
    {
@@ -114,7 +114,7 @@ inline MessageAuthenticationCode* get_mac(const std::string& algo_spec)
 /**
 * String to key algorithm factory method.
 * @param algo_spec the name of the desired string to key (S2K) algorithm
-* @return a pointer to the string to key algorithm object
+* @return pointer to the string to key algorithm object
 */
 BOTAN_DLL S2K* get_s2k(const std::string& algo_spec);
 
@@ -127,7 +127,7 @@ BOTAN_DLL S2K* get_s2k(const std::string& algo_spec);
 /**
 * Factory method for EME (message-encoding methods for encryption) objects
 * @param algo_spec the name of the EME to create
-* @return a pointer to the desired EME object
+* @return pointer to the desired EME object
 */
 BOTAN_DLL EME*  get_eme(const std::string& algo_spec);
 
@@ -135,14 +135,14 @@ BOTAN_DLL EME*  get_eme(const std::string& algo_spec);
 * Factory method for EMSA (message-encoding methods for signatures
 * with appendix) objects
 * @param algo_spec the name of the EME to create
-* @return a pointer to the desired EME object
+* @return pointer to the desired EME object
 */
 BOTAN_DLL EMSA* get_emsa(const std::string& algo_spec);
 
 /**
 * Factory method for KDF (key derivation function)
 * @param algo_spec the name of the KDF to create
-* @return a pointer to the desired KDF object
+* @return pointer to the desired KDF object
 */
 BOTAN_DLL KDF*  get_kdf(const std::string& algo_spec);
 
@@ -158,7 +158,7 @@ BOTAN_DLL KDF*  get_kdf(const std::string& algo_spec);
 * @param iv the initialization vector to be used
 * @param direction determines whether the filter will be an encrypting
 * or decrypting filter
-* @return a pointer to the encryption or decryption filter
+* @return pointer to the encryption or decryption filter
 */
 BOTAN_DLL Keyed_Filter* get_cipher(const std::string& algo_spec,
                                    const SymmetricKey& key,
@@ -172,7 +172,7 @@ BOTAN_DLL Keyed_Filter* get_cipher(const std::string& algo_spec,
 * the filter
 * @param direction determines whether the filter will be an encrypting
 * or decrypting filter
-* @return a pointer to the encryption or decryption filter
+* @return pointer to the encryption or decryption filter
 */
 BOTAN_DLL Keyed_Filter* get_cipher(const std::string& algo_spec,
                                    const SymmetricKey& key,
@@ -185,7 +185,7 @@ BOTAN_DLL Keyed_Filter* get_cipher(const std::string& algo_spec,
 * @param algo_spec the name of the desired cipher
 * @param direction determines whether the filter will be an encrypting or
 * decrypting filter
-* @return a pointer to the encryption or decryption filter
+* @return pointer to the encryption or decryption filter
 */
 BOTAN_DLL Keyed_Filter* get_cipher(const std::string& algo_spec,
                                    Cipher_Dir direction);
diff --git a/src/libstate/oid_lookup/oids.h b/src/libstate/oid_lookup/oids.h
index fdfe61f7c..70b7dee81 100644
--- a/src/libstate/oid_lookup/oids.h
+++ b/src/libstate/oid_lookup/oids.h
@@ -31,7 +31,7 @@ BOTAN_DLL bool have_oid(const std::string& oid);
 /**
 * Resolve an OID
 * @param oid the OID to look up
-* @return the name associated with this OID
+* @return name associated with this OID
 */
 BOTAN_DLL std::string lookup(const OID& oid);
 
@@ -39,7 +39,7 @@ BOTAN_DLL std::string lookup(const OID& oid);
 * Find the OID to a name. The lookup will be performed in the
 * general OID section of the configuration.
 * @param name the name to resolve
-* @return the OID associated with the specified name
+* @return OID associated with the specified name
 */
 BOTAN_DLL OID lookup(const std::string& name);
 
diff --git a/src/libstate/scan_name.h b/src/libstate/scan_name.h
index 49c3d3765..3d11d54f6 100644
--- a/src/libstate/scan_name.h
+++ b/src/libstate/scan_name.h
@@ -28,22 +28,22 @@ class BOTAN_DLL SCAN_Name
       SCAN_Name(std::string algo_spec);
 
       /**
-      * @return the original input string
+      * @return original input string
       */
       std::string as_string() const { return orig_algo_spec; }
 
       /**
-      * @return the algorithm name
+      * @return algorithm name
       */
       std::string algo_name() const { return alg_name; }
 
       /**
-      * @return the algorithm name plus any arguments
+      * @return algorithm name plus any arguments
       */
       std::string algo_name_and_args() const;
 
       /**
-      * @return the number of arguments
+      * @return number of arguments
       */
       u32bit arg_count() const { return args.size(); }
 
@@ -57,32 +57,32 @@ class BOTAN_DLL SCAN_Name
 
       /**
       * @param i which argument
-      * @return the ith argument
+      * @return ith argument
       */
       std::string arg(u32bit i) const;
 
       /**
       * @param i which argument
       * @param def_value the default value
-      * @return the ith argument or the default value
+      * @return ith argument or the default value
       */
       std::string arg(u32bit i, const std::string& def_value) const;
 
       /**
       * @param i which argument
       * @param def_value the default value
-      * @return the ith argument as a u32bit, or the default value
+      * @return ith argument as a u32bit, or the default value
       */
       u32bit arg_as_u32bit(u32bit i, u32bit def_value) const;
 
       /**
-      * @return the cipher mode (if any)
+      * @return cipher mode (if any)
       */
       std::string cipher_mode() const
          { return (mode_info.size() >= 1) ? mode_info[0] : ""; }
 
       /**
-      * @return the cipher mode padding (if any)
+      * @return cipher mode padding (if any)
       */
       std::string cipher_mode_pad() const
          { return (mode_info.size() >= 2) ? mode_info[1] : ""; }