Merge GH #670 Improve Doxygen coverage

1 files changed, 12 insertions, 3 deletions

diff --git a/src/lib/hash/hash.h b/src/lib/hash/hash.h
index 08b5d5243..206333b9f 100644
--- a/src/lib/hash/hash.h
+++ b/src/lib/hash/hash.h
@@ -24,14 +24,17 @@ class BOTAN_DLL HashFunction : public Buffered_Computation
 
       /**
       * Create an instance based on a name
-      * Will return a null pointer if the algo/provider combination cannot
-      * be found. If provider is empty then best available is chosen.
+      * If provider is empty then best available is chosen.
+      * @param algo_spec algorithm name
+      * @param provider provider implementation to use
+      * @return a null pointer if the algo/provider combination cannot be found
       */
       static std::unique_ptr<HashFunction> create(const std::string& algo_spec,
                                                   const std::string& provider = "");
 
       /**
-      * Returns the list of available providers for this algorithm, empty if not available
+      * @return list of available providers for this algorithm, empty if not available
+      * @param algo_spec algorithm name
       */
       static std::vector<std::string> providers(const std::string& algo_spec);
 
@@ -50,8 +53,14 @@ class BOTAN_DLL HashFunction : public Buffered_Computation
 
       virtual ~HashFunction();
 
+      /**
+      * Reset the state.
+      */
       virtual void clear() = 0;
 
+      /**
+      * @return the hash function name
+      */
       virtual std::string name() const = 0;
 
       /**