aboutsummaryrefslogtreecommitdiffstats
path: root/src/stream
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-06-15 23:23:49 +0000
committerlloyd <[email protected]>2010-06-15 23:23:49 +0000
commit76b57a7c4656f0f5759c34efe8bab664b49cd21d (patch)
tree04d4b4d871606e55bec9bddc8fcb57ddd238d21d /src/stream
parentbbe5daf0647a2f0953f1d99272b4e8fbf8d3b6b5 (diff)
More Doxygen updates/fixes
Diffstat (limited to 'src/stream')
-rw-r--r--src/stream/arc4/arc4.h4
-rw-r--r--src/stream/ctr/ctr.h4
-rw-r--r--src/stream/ofb/ofb.h4
-rw-r--r--src/stream/salsa20/salsa20.h4
-rw-r--r--src/stream/stream_cipher.h4
-rw-r--r--src/stream/turing/turing.h2
-rw-r--r--src/stream/wid_wake/wid_wake.h5
7 files changed, 15 insertions, 12 deletions
diff --git a/src/stream/arc4/arc4.h b/src/stream/arc4/arc4.h
index 07633f9ef..78c665985 100644
--- a/src/stream/arc4/arc4.h
+++ b/src/stream/arc4/arc4.h
@@ -13,8 +13,8 @@
namespace Botan {
-/*
-* ARC4
+/**
+* Alleged RC4
*/
class BOTAN_DLL ARC4 : public StreamCipher
{
diff --git a/src/stream/ctr/ctr.h b/src/stream/ctr/ctr.h
index 5f94170cc..4e8d4de7f 100644
--- a/src/stream/ctr/ctr.h
+++ b/src/stream/ctr/ctr.h
@@ -13,8 +13,8 @@
namespace Botan {
-/*
-* CTR-BE (Counter, big-endian)
+/**
+* CTR-BE (Counter mode, big-endian)
*/
class BOTAN_DLL CTR_BE : public StreamCipher
{
diff --git a/src/stream/ofb/ofb.h b/src/stream/ofb/ofb.h
index 1985ae5a9..de212ec2c 100644
--- a/src/stream/ofb/ofb.h
+++ b/src/stream/ofb/ofb.h
@@ -13,8 +13,8 @@
namespace Botan {
-/*
-* OFB Mode
+/**
+* Output Feedback Mode
*/
class BOTAN_DLL OFB : public StreamCipher
{
diff --git a/src/stream/salsa20/salsa20.h b/src/stream/salsa20/salsa20.h
index 67fe54dda..4ba483082 100644
--- a/src/stream/salsa20/salsa20.h
+++ b/src/stream/salsa20/salsa20.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* Salsa20 (and XSalsa20)
+/**
+* DJB's Salsa20 (and XSalsa20)
*/
class BOTAN_DLL Salsa20 : public StreamCipher
{
diff --git a/src/stream/stream_cipher.h b/src/stream/stream_cipher.h
index c5d115a5d..4ce5cb1a4 100644
--- a/src/stream/stream_cipher.h
+++ b/src/stream/stream_cipher.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* Stream Cipher
+/**
+* Base class for all stream ciphers
*/
class BOTAN_DLL StreamCipher : public SymmetricAlgorithm
{
diff --git a/src/stream/turing/turing.h b/src/stream/turing/turing.h
index f9b4460ef..92c5083a4 100644
--- a/src/stream/turing/turing.h
+++ b/src/stream/turing/turing.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* Turing
*/
class BOTAN_DLL Turing : public StreamCipher
diff --git a/src/stream/wid_wake/wid_wake.h b/src/stream/wid_wake/wid_wake.h
index 1c52e8ba1..365a6d9ff 100644
--- a/src/stream/wid_wake/wid_wake.h
+++ b/src/stream/wid_wake/wid_wake.h
@@ -12,8 +12,11 @@
namespace Botan {
-/*
+/**
* WiderWake4+1-BE
+*
+* Note: quite old and possibly not safe; use XSalsa20 or a block
+* cipher in counter mode.
*/
class BOTAN_DLL WiderWake_41_BE : public StreamCipher
{