aboutsummaryrefslogtreecommitdiffstats
path: root/src/utils/buf_comp
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-06-16 03:54:59 +0000
committerlloyd <[email protected]>2010-06-16 03:54:59 +0000
commitaa0c77746be858f094debf0d96e87c02908e8dc3 (patch)
tree98d66a941f476ad035ffc18138998b4bc1dfb8b9 /src/utils/buf_comp
parent85780f6bbe02d7abd573f5b47bf9e79c611f5022 (diff)
Yet more Doxygen comments
Diffstat (limited to 'src/utils/buf_comp')
-rw-r--r--src/utils/buf_comp/buf_comp.h15
1 files changed, 13 insertions, 2 deletions
diff --git a/src/utils/buf_comp/buf_comp.h b/src/utils/buf_comp/buf_comp.h
index bbaa72919..2cc2d87a9 100644
--- a/src/utils/buf_comp/buf_comp.h
+++ b/src/utils/buf_comp/buf_comp.h
@@ -117,8 +117,19 @@ class BOTAN_DLL BufferedComputation
virtual ~BufferedComputation() {}
private:
BufferedComputation& operator=(const BufferedComputation&);
- virtual void add_data(const byte[], u32bit) = 0;
- virtual void final_result(byte[]) = 0;
+
+ /**
+ * Add more data to the computation
+ * @param input is an input buffer
+ * @param length is the length of input in bytes
+ */
+ virtual void add_data(const byte input[], u32bit length) = 0;
+
+ /**
+ * Write the final output to out
+ * @param out is an output buffer of OUTPUT_LENGTH
+ */
+ virtual void final_result(byte out[]) = 0;
};
}