From 9151952c4174607678139f9ccb582aa3b886b519 Mon Sep 17 00:00:00 2001 From: lloyd Date: Tue, 30 Oct 2012 03:32:54 +0000 Subject: Doxygen --- src/algo_base/buf_comp.h | 6 ++++++ src/block/block_cipher.h | 2 +- src/hash/hash.h | 4 ++-- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/src/algo_base/buf_comp.h b/src/algo_base/buf_comp.h index 1dd8be992..f25af3b92 100644 --- a/src/algo_base/buf_comp.h +++ b/src/algo_base/buf_comp.h @@ -126,6 +126,12 @@ class BOTAN_DLL Buffered_Computation return final(); } + /** + * Update and finalize computation. Does the same as calling update() + * and final() consecutively. + * @param in the input to process + * @result the result of the call to final() + */ secure_vector process(const std::vector& in) { add_data(&in[0], in.size()); diff --git a/src/block/block_cipher.h b/src/block/block_cipher.h index 4a07bb048..5cbd6bdae 100644 --- a/src/block/block_cipher.h +++ b/src/block/block_cipher.h @@ -136,7 +136,7 @@ class BOTAN_DLL BlockCipher : public SymmetricAlgorithm size_t blocks) const = 0; /** - * Get a new object representing the same algorithm as *this + * @return new object representing the same algorithm as *this */ virtual BlockCipher* clone() const = 0; }; diff --git a/src/hash/hash.h b/src/hash/hash.h index 8143e8e90..1e4b045e2 100644 --- a/src/hash/hash.h +++ b/src/hash/hash.h @@ -22,12 +22,12 @@ class BOTAN_DLL HashFunction : public Buffered_Computation, { public: /** - * Get a new object representing the same algorithm as *this + * @return new object representing the same algorithm as *this */ virtual HashFunction* clone() const = 0; /** - * The hash block size as defined for this algorithm + * @return hash block size as defined for this algorithm */ virtual size_t hash_block_size() const { return 0; } }; -- cgit v1.2.3