aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/mac
diff options
context:
space:
mode:
authorRenĂ© Korthaus <[email protected]>2016-10-16 12:34:20 +0200
committerRenĂ© Korthaus <[email protected]>2016-10-19 09:13:18 +0200
commitc64248f9f61da376ae0effd12a94118f79c84356 (patch)
treef5146e4fa826743fef97fae8a0de1d15237f6fc6 /src/lib/mac
parentff51a82f49b05563d1a3dca02c8afd9312fe4fde (diff)
Improve mac doxygen [ci skip]
Diffstat (limited to 'src/lib/mac')
-rw-r--r--src/lib/mac/mac.h10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/lib/mac/mac.h b/src/lib/mac/mac.h
index ae8ea5405..f742d7db4 100644
--- a/src/lib/mac/mac.h
+++ b/src/lib/mac/mac.h
@@ -26,14 +26,16 @@ class BOTAN_DLL MessageAuthenticationCode : 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<MessageAuthenticationCode> 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
*/
static std::vector<std::string> providers(const std::string& algo_spec);
@@ -48,7 +50,7 @@ class BOTAN_DLL MessageAuthenticationCode : public Buffered_Computation,
virtual bool verify_mac(const byte in[], size_t length);
/**
- * Get a new object representing the same algorithm as *this
+ * @return a new object representing the same algorithm as *this
*/
virtual MessageAuthenticationCode* clone() const = 0;