aboutsummaryrefslogtreecommitdiffstats
path: root/src/block
diff options
context:
space:
mode:
authorlloyd <[email protected]>2010-06-15 22:28:02 +0000
committerlloyd <[email protected]>2010-06-15 22:28:02 +0000
commit7dbef9e3e2efd2354bb4ca97fca0d720a8957db4 (patch)
treee6d563d6658a93ba5caffcf8975a065d98ca6c38 /src/block
parent416695f7363c4e93eaeaea23427a1fed3ad73cab (diff)
More Doxygen fixes
Diffstat (limited to 'src/block')
-rw-r--r--src/block/blowfish/blowfish.h2
-rw-r--r--src/block/cascade/cascade.h2
-rw-r--r--src/block/cast/cast128.h2
-rw-r--r--src/block/cast/cast256.h2
-rw-r--r--src/block/des/des.h4
-rw-r--r--src/block/des/desx.h2
-rw-r--r--src/block/idea/idea.h2
-rw-r--r--src/block/idea_sse2/idea_sse2.h2
-rw-r--r--src/block/kasumi/kasumi.h4
-rw-r--r--src/block/lion/lion.h9
-rw-r--r--src/block/lubyrack/lubyrack.h4
-rw-r--r--src/block/mars/mars.h3
-rw-r--r--src/block/noekeon/noekeon.h2
-rw-r--r--src/block/noekeon_simd/noekeon_simd.h4
-rw-r--r--src/block/rc2/rc2.h2
-rw-r--r--src/block/rc5/rc5.h2
-rw-r--r--src/block/rc6/rc6.h4
-rw-r--r--src/block/safer/safer_sk.h2
-rw-r--r--src/block/seed/seed.h4
-rw-r--r--src/block/serpent/serpent.h4
-rw-r--r--src/block/serpent_ia32/serp_ia32.h4
-rw-r--r--src/block/serpent_simd/serp_simd.h4
-rw-r--r--src/block/skipjack/skipjack.h4
-rw-r--r--src/block/square/square.h2
-rw-r--r--src/block/tea/tea.h2
-rw-r--r--src/block/twofish/twofish.h4
-rw-r--r--src/block/xtea/xtea.h2
-rw-r--r--src/block/xtea_simd/xtea_simd.h4
28 files changed, 48 insertions, 40 deletions
diff --git a/src/block/blowfish/blowfish.h b/src/block/blowfish/blowfish.h
index 2306f0e37..a178ec488 100644
--- a/src/block/blowfish/blowfish.h
+++ b/src/block/blowfish/blowfish.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* Blowfish
*/
class BOTAN_DLL Blowfish : public BlockCipher
diff --git a/src/block/cascade/cascade.h b/src/block/cascade/cascade.h
index 98c64fb3e..263a9e8a1 100644
--- a/src/block/cascade/cascade.h
+++ b/src/block/cascade/cascade.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* Block Cipher Cascade
*/
class BOTAN_DLL Cascade_Cipher : public BlockCipher
diff --git a/src/block/cast/cast128.h b/src/block/cast/cast128.h
index 048d2e43c..967e91938 100644
--- a/src/block/cast/cast128.h
+++ b/src/block/cast/cast128.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* CAST-128
*/
class BOTAN_DLL CAST_128 : public BlockCipher
diff --git a/src/block/cast/cast256.h b/src/block/cast/cast256.h
index 170d94e77..c4a305671 100644
--- a/src/block/cast/cast256.h
+++ b/src/block/cast/cast256.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* CAST-256
*/
class BOTAN_DLL CAST_256 : public BlockCipher
diff --git a/src/block/des/des.h b/src/block/des/des.h
index 32dd3daf6..1ae806850 100644
--- a/src/block/des/des.h
+++ b/src/block/des/des.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* DES
*/
class BOTAN_DLL DES : public BlockCipher
@@ -32,7 +32,7 @@ class BOTAN_DLL DES : public BlockCipher
SecureVector<u32bit, 32> round_key;
};
-/*
+/**
* Triple DES
*/
class BOTAN_DLL TripleDES : public BlockCipher
diff --git a/src/block/des/desx.h b/src/block/des/desx.h
index 440574e9d..45a9d8479 100644
--- a/src/block/des/desx.h
+++ b/src/block/des/desx.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* DESX
*/
class BOTAN_DLL DESX : public BlockCipher
diff --git a/src/block/idea/idea.h b/src/block/idea/idea.h
index 1a9644d4e..be1417a36 100644
--- a/src/block/idea/idea.h
+++ b/src/block/idea/idea.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* IDEA
*/
class BOTAN_DLL IDEA : public BlockCipher
diff --git a/src/block/idea_sse2/idea_sse2.h b/src/block/idea_sse2/idea_sse2.h
index 585de7264..b00e0f400 100644
--- a/src/block/idea_sse2/idea_sse2.h
+++ b/src/block/idea_sse2/idea_sse2.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* IDEA in SSE2
*/
class BOTAN_DLL IDEA_SSE2 : public IDEA
diff --git a/src/block/kasumi/kasumi.h b/src/block/kasumi/kasumi.h
index 827989a57..fda348ef3 100644
--- a/src/block/kasumi/kasumi.h
+++ b/src/block/kasumi/kasumi.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* KASUMI
+/**
+* KASUMI, the block cipher used in 3G telephony
*/
class BOTAN_DLL KASUMI : public BlockCipher
{
diff --git a/src/block/lion/lion.h b/src/block/lion/lion.h
index f24acdb72..07556399b 100644
--- a/src/block/lion/lion.h
+++ b/src/block/lion/lion.h
@@ -14,8 +14,13 @@
namespace Botan {
-/*
-* Lion
+/**
+* Lion is a block cipher construction designed by Ross Anderson and
+* Eli Biham, described in "Two Practical and Provably Secure Block
+* Ciphers: BEAR and LION". It has a variable block size and is
+* designed to encrypt very large blocks (up to a megabyte)
+
+* http://www.cl.cam.ac.uk/~rja14/Papers/bear-lion.pdf
*/
class BOTAN_DLL Lion : public BlockCipher
{
diff --git a/src/block/lubyrack/lubyrack.h b/src/block/lubyrack/lubyrack.h
index 7249cf157..29b7ee5a4 100644
--- a/src/block/lubyrack/lubyrack.h
+++ b/src/block/lubyrack/lubyrack.h
@@ -13,8 +13,8 @@
namespace Botan {
-/*
-* Luby-Rackoff
+/**
+* Luby-Rackoff block cipher construction
*/
class BOTAN_DLL LubyRackoff : public BlockCipher
{
diff --git a/src/block/mars/mars.h b/src/block/mars/mars.h
index f2a6d0197..f455ec5ca 100644
--- a/src/block/mars/mars.h
+++ b/src/block/mars/mars.h
@@ -12,6 +12,9 @@
namespace Botan {
+/**
+* MARS, IBM's candidate for AES
+*/
class BOTAN_DLL MARS : public BlockCipher
{
public:
diff --git a/src/block/noekeon/noekeon.h b/src/block/noekeon/noekeon.h
index abeecbc64..5b04a135d 100644
--- a/src/block/noekeon/noekeon.h
+++ b/src/block/noekeon/noekeon.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* Noekeon
*/
class BOTAN_DLL Noekeon : public BlockCipher
diff --git a/src/block/noekeon_simd/noekeon_simd.h b/src/block/noekeon_simd/noekeon_simd.h
index aba1e3d65..507f17e21 100644
--- a/src/block/noekeon_simd/noekeon_simd.h
+++ b/src/block/noekeon_simd/noekeon_simd.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* Noekeon
+/**
+* Noekeon implementation using SIMD operations
*/
class BOTAN_DLL Noekeon_SIMD : public Noekeon
{
diff --git a/src/block/rc2/rc2.h b/src/block/rc2/rc2.h
index dd0295572..d4ecac462 100644
--- a/src/block/rc2/rc2.h
+++ b/src/block/rc2/rc2.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* RC2
*/
class BOTAN_DLL RC2 : public BlockCipher
diff --git a/src/block/rc5/rc5.h b/src/block/rc5/rc5.h
index 82931c1d2..5135336b1 100644
--- a/src/block/rc5/rc5.h
+++ b/src/block/rc5/rc5.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* RC5
*/
class BOTAN_DLL RC5 : public BlockCipher
diff --git a/src/block/rc6/rc6.h b/src/block/rc6/rc6.h
index cc1534ee2..9b2d587fa 100644
--- a/src/block/rc6/rc6.h
+++ b/src/block/rc6/rc6.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* RC6
+/**
+* RC6, Ron Rivest's AES candidate
*/
class BOTAN_DLL RC6 : public BlockCipher
{
diff --git a/src/block/safer/safer_sk.h b/src/block/safer/safer_sk.h
index 80d2dc069..3386102e4 100644
--- a/src/block/safer/safer_sk.h
+++ b/src/block/safer/safer_sk.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* SAFER-SK
*/
class BOTAN_DLL SAFER_SK : public BlockCipher
diff --git a/src/block/seed/seed.h b/src/block/seed/seed.h
index e56b77dbb..0c80199ad 100644
--- a/src/block/seed/seed.h
+++ b/src/block/seed/seed.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* SEED
+/**
+* SEED, a Korean block cipher
*/
class BOTAN_DLL SEED : public BlockCipher
{
diff --git a/src/block/serpent/serpent.h b/src/block/serpent/serpent.h
index 37ce10c7b..2bbe2f71f 100644
--- a/src/block/serpent/serpent.h
+++ b/src/block/serpent/serpent.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* Serpent
+/**
+* Serpent, an AES finalist
*/
class BOTAN_DLL Serpent : public BlockCipher
{
diff --git a/src/block/serpent_ia32/serp_ia32.h b/src/block/serpent_ia32/serp_ia32.h
index dc6beaf13..229a2042b 100644
--- a/src/block/serpent_ia32/serp_ia32.h
+++ b/src/block/serpent_ia32/serp_ia32.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* Serpent
+/**
+* Serpent implementation in x86 assembly
*/
class BOTAN_DLL Serpent_IA32 : public Serpent
{
diff --git a/src/block/serpent_simd/serp_simd.h b/src/block/serpent_simd/serp_simd.h
index 54bfa1dd7..f0a11fc93 100644
--- a/src/block/serpent_simd/serp_simd.h
+++ b/src/block/serpent_simd/serp_simd.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* Serpent
+/**
+* Serpent implementation using SIMD
*/
class BOTAN_DLL Serpent_SIMD : public Serpent
{
diff --git a/src/block/skipjack/skipjack.h b/src/block/skipjack/skipjack.h
index d481aee08..29978efc7 100644
--- a/src/block/skipjack/skipjack.h
+++ b/src/block/skipjack/skipjack.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* Skipjack
+/**
+* Skipjack, a NSA designed cipher used in Fortezza
*/
class BOTAN_DLL Skipjack : public BlockCipher
{
diff --git a/src/block/square/square.h b/src/block/square/square.h
index 8e1f7f815..a17771f11 100644
--- a/src/block/square/square.h
+++ b/src/block/square/square.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* Square
*/
class BOTAN_DLL Square : public BlockCipher
diff --git a/src/block/tea/tea.h b/src/block/tea/tea.h
index 152c9a905..128f42080 100644
--- a/src/block/tea/tea.h
+++ b/src/block/tea/tea.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* TEA
*/
class BOTAN_DLL TEA : public BlockCipher
diff --git a/src/block/twofish/twofish.h b/src/block/twofish/twofish.h
index 7600abca8..3191dc963 100644
--- a/src/block/twofish/twofish.h
+++ b/src/block/twofish/twofish.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* Twofish
+/**
+* Twofish, an AES finalist
*/
class BOTAN_DLL Twofish : public BlockCipher
{
diff --git a/src/block/xtea/xtea.h b/src/block/xtea/xtea.h
index 940992dfa..b16cdf555 100644
--- a/src/block/xtea/xtea.h
+++ b/src/block/xtea/xtea.h
@@ -12,7 +12,7 @@
namespace Botan {
-/*
+/**
* XTEA
*/
class BOTAN_DLL XTEA : public BlockCipher
diff --git a/src/block/xtea_simd/xtea_simd.h b/src/block/xtea_simd/xtea_simd.h
index e114bf63a..87eeb433b 100644
--- a/src/block/xtea_simd/xtea_simd.h
+++ b/src/block/xtea_simd/xtea_simd.h
@@ -12,8 +12,8 @@
namespace Botan {
-/*
-* XTEA (SIMD variant)
+/**
+* XTEA implemented using SIMD operations
*/
class BOTAN_DLL XTEA_SIMD : public XTEA
{