diff options
author | lloyd <[email protected]> | 2010-06-16 00:52:24 +0000 |
---|---|---|
committer | lloyd <[email protected]> | 2010-06-16 00:52:24 +0000 |
commit | ecb574d32f4382326e94ad19e9d5baecc84a3c29 (patch) | |
tree | 55e98453b046e8553bc21fc2153939032718bbec /src/stream | |
parent | b1405ff3191a4343d098c513af157d831723b92d (diff) |
More Doxygen comments
Diffstat (limited to 'src/stream')
-rw-r--r-- | src/stream/arc4/arc4.h | 6 | ||||
-rw-r--r-- | src/stream/ctr/ctr.h | 5 | ||||
-rw-r--r-- | src/stream/ofb/ofb.h | 5 |
3 files changed, 13 insertions, 3 deletions
diff --git a/src/stream/arc4/arc4.h b/src/stream/arc4/arc4.h index 78c665985..0488783ef 100644 --- a/src/stream/arc4/arc4.h +++ b/src/stream/arc4/arc4.h @@ -26,7 +26,11 @@ class BOTAN_DLL ARC4 : public StreamCipher StreamCipher* clone() const { return new ARC4(SKIP); } - ARC4(u32bit = 0); + /** + * @param skip skip this many initial bytes in the keystream + */ + ARC4(u32bit skip = 0); + ~ARC4() { clear(); } private: void key_schedule(const byte[], u32bit); diff --git a/src/stream/ctr/ctr.h b/src/stream/ctr/ctr.h index 4e8d4de7f..fc7ba522f 100644 --- a/src/stream/ctr/ctr.h +++ b/src/stream/ctr/ctr.h @@ -33,7 +33,10 @@ class BOTAN_DLL CTR_BE : public StreamCipher void clear(); - CTR_BE(BlockCipher*); + /** + * @param cipher the underlying block cipher to use + */ + CTR_BE(BlockCipher* cipher); ~CTR_BE(); private: void key_schedule(const byte key[], u32bit key_len); diff --git a/src/stream/ofb/ofb.h b/src/stream/ofb/ofb.h index de212ec2c..2871dd8ee 100644 --- a/src/stream/ofb/ofb.h +++ b/src/stream/ofb/ofb.h @@ -33,7 +33,10 @@ class BOTAN_DLL OFB : public StreamCipher void clear(); - OFB(BlockCipher*); + /** + * @param cipher the underlying block cipher to use + */ + OFB(BlockCipher* cipher); ~OFB(); private: void key_schedule(const byte key[], u32bit key_len); |