Doxygen comments

1 files changed, 82 insertions, 14 deletions

diff --git a/src/engine/engine.h b/src/engine/engine.h
index 9937d1dda..6e8133692 100644
--- a/src/engine/engine.h
+++ b/src/engine/engine.h
@@ -34,56 +34,124 @@ class BOTAN_DLL Engine
    public:
       virtual ~Engine() {}
 
+      /**
+      * @return name of this engine
+      */
       virtual std::string provider_name() const = 0;
 
-      // Lookup functions
+      /**
+      * @param algo_spec the algorithm name/specification
+      * @param af an algorithm factory object
+      * @return newly allocated object, or NULL
+      */
       virtual BlockCipher*
-         find_block_cipher(const SCAN_Name&, Algorithm_Factory&) const
+         find_block_cipher(const SCAN_Name& algo_spec,
+                           Algorithm_Factory& af) const
          { return 0; }
 
+      /**
+      * @param algo_spec the algorithm name/specification
+      * @param af an algorithm factory object
+      * @return newly allocated object, or NULL
+      */
       virtual StreamCipher*
-         find_stream_cipher(const SCAN_Name&, Algorithm_Factory&) const
+         find_stream_cipher(const SCAN_Name& algo_spec,
+                            Algorithm_Factory& af) const
          { return 0; }
 
+      /**
+      * @param algo_spec the algorithm name/specification
+      * @param af an algorithm factory object
+      * @return newly allocated object, or NULL
+      */
       virtual HashFunction*
-         find_hash(const SCAN_Name&, Algorithm_Factory&) const
+         find_hash(const SCAN_Name& algo_spec,
+                   Algorithm_Factory& af) const
          { return 0; }
 
+      /**
+      * @param algo_spec the algorithm name/specification
+      * @param af an algorithm factory object
+      * @return newly allocated object, or NULL
+      */
       virtual MessageAuthenticationCode*
-         find_mac(const SCAN_Name&, Algorithm_Factory&) const
+         find_mac(const SCAN_Name& algo_spec,
+                  Algorithm_Factory& af) const
          { return 0; }
 
+      /**
+      * @param n the modulus
+      * @param hints any use hints
+      * @return newly allocated object, or NULL
+      */
       virtual Modular_Exponentiator*
-         mod_exp(const BigInt&, Power_Mod::Usage_Hints) const
+         mod_exp(const BigInt& n,
+                 Power_Mod::Usage_Hints hints) const
          { return 0; }
 
-      virtual Keyed_Filter* get_cipher(const std::string&,
-                                       Cipher_Dir,
-                                       Algorithm_Factory&)
+      /**
+      * Return a new cipher object
+      * @param algo_spec the algorithm name/specification
+      * @param dir specifies if encryption or decryption is desired
+      * @param af an algorithm factory object
+      * @return newly allocated object, or NULL
+      */
+      virtual Keyed_Filter* get_cipher(const std::string& algo_spec,
+                                       Cipher_Dir dir,
+                                       Algorithm_Factory& af)
          { return 0; }
 
+      /**
+      * Return a new operator object for this key, if possible
+      * @param key the key we want an operator for
+      * @return newly allocated operator object, or NULL
+      */
       virtual PK_Ops::Key_Agreement*
-         get_key_agreement_op(const Private_Key&) const
+         get_key_agreement_op(const Private_Key& key) const
          {
          return 0;
          }
 
-      virtual PK_Ops::Signature* get_signature_op(const Private_Key&) const
+      /**
+      * Return a new operator object for this key, if possible
+      * @param key the key we want an operator for
+      * @return newly allocated operator object, or NULL
+      */
+      virtual PK_Ops::Signature*
+         get_signature_op(const Private_Key& key) const
          {
          return 0;
          }
 
-      virtual PK_Ops::Verification* get_verify_op(const Public_Key&) const
+      /**
+      * Return a new operator object for this key, if possible
+      * @param key the key we want an operator for
+      * @return newly allocated operator object, or NULL
+      */
+      virtual PK_Ops::Verification*
+         get_verify_op(const Public_Key& key) const
          {
          return 0;
          }
 
-      virtual PK_Ops::Encryption* get_encryption_op(const Public_Key&) const
+      /**
+      * Return a new operator object for this key, if possible
+      * @param key the key we want an operator for
+      * @return newly allocated operator object, or NULL
+      */
+      virtual PK_Ops::Encryption*
+         get_encryption_op(const Public_Key& key) const
          {
          return 0;
          }
 
-      virtual PK_Ops::Decryption* get_decryption_op(const Private_Key&) const
+      /**
+      * Return a new operator object for this key, if possible
+      * @param key the key we want an operator for
+      * @return newly allocated operator object, or NULL
+      */
+      virtual PK_Ops::Decryption*
+         get_decryption_op(const Private_Key& key) const
          {
          return 0;
          }