aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/hash/hash.h
diff options
context:
space:
mode:
authorRenĂ© Korthaus <[email protected]>2016-10-16 11:38:39 +0200
committerRenĂ© Korthaus <[email protected]>2016-10-19 09:13:15 +0200
commita99368c957ffd9631571e441f19de0dd32c0d37a (patch)
tree713db78bba905978c2306759aad83e85e586e8cf /src/lib/hash/hash.h
parentf6269b7e10b2641946d091a4afeda592980798a9 (diff)
Improve hash doxygen [ci skip]
Diffstat (limited to 'src/lib/hash/hash.h')
-rw-r--r--src/lib/hash/hash.h15
1 files changed, 12 insertions, 3 deletions
diff --git a/src/lib/hash/hash.h b/src/lib/hash/hash.h
index 08b5d5243..9bc06e953 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 choose
+ * @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;
/**