aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorRenĂ© Korthaus <[email protected]>2016-10-16 11:17:56 +0200
committerRenĂ© Korthaus <[email protected]>2016-10-19 09:13:12 +0200
commitf6269b7e10b2641946d091a4afeda592980798a9 (patch)
tree1eeffe61cebf2da837f25f4710d5bfdbab90e246 /src
parentd1817c9960f619b130388a570ed09ccbed568e2e (diff)
Improve block doxygen [ci skip]
Diffstat (limited to 'src')
-rw-r--r--src/lib/block/block_cipher.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/lib/block/block_cipher.h b/src/lib/block/block_cipher.h
index b16468958..7c7084155 100644
--- a/src/lib/block/block_cipher.h
+++ b/src/lib/block/block_cipher.h
@@ -24,14 +24,17 @@ class BOTAN_DLL BlockCipher : public SymmetricAlgorithm
/**
* 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<BlockCipher> 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);