diff options
| author | René Korthaus <[email protected]> | 2016-10-07 12:01:07 +0200 |
|---|---|---|
| committer | René Korthaus <[email protected]> | 2016-10-11 11:22:04 +0200 |
| commit | b2b7909709f281b178e3a1141c9db6fea049f8db (patch) | |
| tree | ddd4bf26d881b69b7371a4b757f701ecde13dd48 /src/lib/base/sym_algo.h | |
| parent | e402cbacbb08784753772dba9ee5e48f9d64d71e (diff) | |
Improve base doxygen [ci skip]
Diffstat (limited to 'src/lib/base/sym_algo.h')
| -rw-r--r-- | src/lib/base/sym_algo.h | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/src/lib/base/sym_algo.h b/src/lib/base/sym_algo.h index ee6eb5f4a..c8c93ba34 100644 --- a/src/lib/base/sym_algo.h +++ b/src/lib/base/sym_algo.h @@ -23,6 +23,9 @@ class BOTAN_DLL SymmetricAlgorithm public: virtual ~SymmetricAlgorithm() {} + /** + * Reset the state. + */ virtual void clear() = 0; /** @@ -39,7 +42,7 @@ class BOTAN_DLL SymmetricAlgorithm } /** - * @return maxmium allowed key length + * @return maximum allowed key length */ size_t minimum_keylength() const { @@ -83,6 +86,9 @@ class BOTAN_DLL SymmetricAlgorithm key_schedule(key, length); } + /* + * @return the algorithm name + */ virtual std::string name() const = 0; private: |