Format block comments for Doxygen

2 files changed, 64 insertions, 56 deletions

diff --git a/src/block/aes/aes.cpp b/src/block/aes/aes.cpp
index 5e934a9f1..06c1b8fd6 100644
--- a/src/block/aes/aes.cpp
+++ b/src/block/aes/aes.cpp
@@ -1,16 +1,16 @@
-/*************************************************
-* AES Source File                                *
-* (C) 1999-2007 Jack Lloyd                       *
-*************************************************/
+/**
+* AES Source File
+* (C) 1999-2007 Jack Lloyd
+*/
 
 #include <botan/aes.h>
 #include <botan/loadstor.h>
 
 namespace Botan {
 
-/*************************************************
-* AES Encryption                                 *
-*************************************************/
+/**
+* AES Encryption
+*/
 void AES::enc(const byte in[], byte out[]) const
    {
    const u32bit* TE0 = TE;
@@ -18,17 +18,19 @@ void AES::enc(const byte in[], byte out[]) const
    const u32bit* TE2 = TE + 512;
    const u32bit* TE3 = TE + 768;
 
-   u32bit T0, T1, T2, T3, B0, B1, B2, B3;
-   B0 = TE0[in[ 0] ^ ME[ 0]] ^ TE1[in[ 5] ^ ME[ 5]] ^
-        TE2[in[10] ^ ME[10]] ^ TE3[in[15] ^ ME[15]] ^ EK[0];
-   B1 = TE0[in[ 4] ^ ME[ 4]] ^ TE1[in[ 9] ^ ME[ 9]] ^
-        TE2[in[14] ^ ME[14]] ^ TE3[in[ 3] ^ ME[ 3]] ^ EK[1];
-   B2 = TE0[in[ 8] ^ ME[ 8]] ^ TE1[in[13] ^ ME[13]] ^
-        TE2[in[ 2] ^ ME[ 2]] ^ TE3[in[ 7] ^ ME[ 7]] ^ EK[2];
-   B3 = TE0[in[12] ^ ME[12]] ^ TE1[in[ 1] ^ ME[ 1]] ^
-        TE2[in[ 6] ^ ME[ 6]] ^ TE3[in[11] ^ ME[11]] ^ EK[3];
+   u32bit B0 = TE0[in[ 0] ^ ME[ 0]] ^ TE1[in[ 5] ^ ME[ 5]] ^
+               TE2[in[10] ^ ME[10]] ^ TE3[in[15] ^ ME[15]] ^ EK[0];
+   u32bit B1 = TE0[in[ 4] ^ ME[ 4]] ^ TE1[in[ 9] ^ ME[ 9]] ^
+               TE2[in[14] ^ ME[14]] ^ TE3[in[ 3] ^ ME[ 3]] ^ EK[1];
+   u32bit B2 = TE0[in[ 8] ^ ME[ 8]] ^ TE1[in[13] ^ ME[13]] ^
+               TE2[in[ 2] ^ ME[ 2]] ^ TE3[in[ 7] ^ ME[ 7]] ^ EK[2];
+   u32bit B3 = TE0[in[12] ^ ME[12]] ^ TE1[in[ 1] ^ ME[ 1]] ^
+               TE2[in[ 6] ^ ME[ 6]] ^ TE3[in[11] ^ ME[11]] ^ EK[3];
+
    for(u32bit j = 1; j != ROUNDS - 1; j += 2)
       {
+      u32bit T0, T1, T2, T3;
+
       T0 = TE0[get_byte(0, B0)] ^ TE1[get_byte(1, B1)] ^
            TE2[get_byte(2, B2)] ^ TE3[get_byte(3, B3)] ^ EK[4*j+0];
       T1 = TE0[get_byte(0, B1)] ^ TE1[get_byte(1, B2)] ^
@@ -37,6 +39,7 @@ void AES::enc(const byte in[], byte out[]) const
            TE2[get_byte(2, B0)] ^ TE3[get_byte(3, B1)] ^ EK[4*j+2];
       T3 = TE0[get_byte(0, B3)] ^ TE1[get_byte(1, B0)] ^
            TE2[get_byte(2, B1)] ^ TE3[get_byte(3, B2)] ^ EK[4*j+3];
+
       B0 = TE0[get_byte(0, T0)] ^ TE1[get_byte(1, T1)] ^
            TE2[get_byte(2, T2)] ^ TE3[get_byte(3, T3)] ^ EK[4*j+4];
       B1 = TE0[get_byte(0, T1)] ^ TE1[get_byte(1, T2)] ^
@@ -46,6 +49,7 @@ void AES::enc(const byte in[], byte out[]) const
       B3 = TE0[get_byte(0, T3)] ^ TE1[get_byte(1, T0)] ^
            TE2[get_byte(2, T1)] ^ TE3[get_byte(3, T2)] ^ EK[4*j+7];
       }
+
    out[ 0] = SE[get_byte(0, B0)] ^ ME[16];
    out[ 1] = SE[get_byte(1, B1)] ^ ME[17];
    out[ 2] = SE[get_byte(2, B2)] ^ ME[18];
@@ -64,9 +68,9 @@ void AES::enc(const byte in[], byte out[]) const
    out[15] = SE[get_byte(3, B2)] ^ ME[31];
    }
 
-/*************************************************
-* AES Decryption                                 *
-*************************************************/
+/**
+* AES Decryption
+*/
 void AES::dec(const byte in[], byte out[]) const
    {
    const u32bit* TD0 = TD;
@@ -74,17 +78,19 @@ void AES::dec(const byte in[], byte out[]) const
    const u32bit* TD2 = TD + 512;
    const u32bit* TD3 = TD + 768;
 
-   u32bit T0, T1, T2, T3, B0, B1, B2, B3;
-   B0 = TD0[in[ 0] ^ MD[ 0]] ^ TD1[in[13] ^ MD[13]] ^
-        TD2[in[10] ^ MD[10]] ^ TD3[in[ 7] ^ MD[ 7]] ^ DK[0];
-   B1 = TD0[in[ 4] ^ MD[ 4]] ^ TD1[in[ 1] ^ MD[ 1]] ^
-        TD2[in[14] ^ MD[14]] ^ TD3[in[11] ^ MD[11]] ^ DK[1];
-   B2 = TD0[in[ 8] ^ MD[ 8]] ^ TD1[in[ 5] ^ MD[ 5]] ^
-        TD2[in[ 2] ^ MD[ 2]] ^ TD3[in[15] ^ MD[15]] ^ DK[2];
-   B3 = TD0[in[12] ^ MD[12]] ^ TD1[in[ 9] ^ MD[ 9]] ^
-        TD2[in[ 6] ^ MD[ 6]] ^ TD3[in[ 3] ^ MD[ 3]] ^ DK[3];
+   u32bit B0 = TD0[in[ 0] ^ MD[ 0]] ^ TD1[in[13] ^ MD[13]] ^
+               TD2[in[10] ^ MD[10]] ^ TD3[in[ 7] ^ MD[ 7]] ^ DK[0];
+   u32bit B1 = TD0[in[ 4] ^ MD[ 4]] ^ TD1[in[ 1] ^ MD[ 1]] ^
+               TD2[in[14] ^ MD[14]] ^ TD3[in[11] ^ MD[11]] ^ DK[1];
+   u32bit B2 = TD0[in[ 8] ^ MD[ 8]] ^ TD1[in[ 5] ^ MD[ 5]] ^
+               TD2[in[ 2] ^ MD[ 2]] ^ TD3[in[15] ^ MD[15]] ^ DK[2];
+   u32bit B3 = TD0[in[12] ^ MD[12]] ^ TD1[in[ 9] ^ MD[ 9]] ^
+               TD2[in[ 6] ^ MD[ 6]] ^ TD3[in[ 3] ^ MD[ 3]] ^ DK[3];
+
    for(u32bit j = 1; j != ROUNDS - 1; j += 2)
       {
+      u32bit T0, T1, T2, T3;
+
       T0 = TD0[get_byte(0, B0)] ^ TD1[get_byte(1, B3)] ^
            TD2[get_byte(2, B2)] ^ TD3[get_byte(3, B1)] ^ DK[4*j+0];
       T1 = TD0[get_byte(0, B1)] ^ TD1[get_byte(1, B0)] ^
@@ -93,6 +99,7 @@ void AES::dec(const byte in[], byte out[]) const
            TD2[get_byte(2, B0)] ^ TD3[get_byte(3, B3)] ^ DK[4*j+2];
       T3 = TD0[get_byte(0, B3)] ^ TD1[get_byte(1, B2)] ^
            TD2[get_byte(2, B1)] ^ TD3[get_byte(3, B0)] ^ DK[4*j+3];
+
       B0 = TD0[get_byte(0, T0)] ^ TD1[get_byte(1, T3)] ^
            TD2[get_byte(2, T2)] ^ TD3[get_byte(3, T1)] ^ DK[4*j+4];
       B1 = TD0[get_byte(0, T1)] ^ TD1[get_byte(1, T0)] ^
@@ -102,6 +109,7 @@ void AES::dec(const byte in[], byte out[]) const
       B3 = TD0[get_byte(0, T3)] ^ TD1[get_byte(1, T2)] ^
            TD2[get_byte(2, T1)] ^ TD3[get_byte(3, T0)] ^ DK[4*j+7];
       }
+
    out[ 0] = SD[get_byte(0, B0)] ^ MD[16];
    out[ 1] = SD[get_byte(1, B3)] ^ MD[17];
    out[ 2] = SD[get_byte(2, B2)] ^ MD[18];
@@ -120,9 +128,9 @@ void AES::dec(const byte in[], byte out[]) const
    out[15] = SD[get_byte(3, B0)] ^ MD[31];
    }
 
-/*************************************************
-* AES Key Schedule                               *
-*************************************************/
+/**
+* AES Key Schedule
+*/
 void AES::key_schedule(const byte key[], u32bit length)
    {
    static const u32bit RC[10] = {
@@ -175,18 +183,18 @@ void AES::key_schedule(const byte key[], u32bit length)
    DK.copy(XDK + 4, length + 20);
    }
 
-/*************************************************
-* AES Byte Substitution                          *
-*************************************************/
+/**
+* AES Byte Substitution
+*/
 u32bit AES::S(u32bit input)
    {
    return make_u32bit(SE[get_byte(0, input)], SE[get_byte(1, input)],
                       SE[get_byte(2, input)], SE[get_byte(3, input)]);
    }
 
-/*************************************************
-* AES Constructor                                *
-*************************************************/
+/**
+* AES Constructor
+*/
 AES::AES(u32bit key_size) : BlockCipher(16, key_size)
    {
    if(key_size != 16 && key_size != 24 && key_size != 32)
@@ -194,9 +202,9 @@ AES::AES(u32bit key_size) : BlockCipher(16, key_size)
    ROUNDS = (key_size / 4) + 6;
    }
 
-/*************************************************
-* Clear memory of sensitive data                 *
-*************************************************/
+/**
+* Clear memory of sensitive data
+*/
 void AES::clear() throw()
    {
    EK.clear();
diff --git a/src/block/aes/aes.h b/src/block/aes/aes.h
index 28728a666..9b84e572c 100644
--- a/src/block/aes/aes.h
+++ b/src/block/aes/aes.h
@@ -1,7 +1,7 @@
-/*************************************************
-* AES Header File                                *
-* (C) 1999-2007 Jack Lloyd                       *
-*************************************************/
+/**
+* AES Header File
+* (C) 1999-2007 Jack Lloyd
+*/
 
 #ifndef BOTAN_AES_H__
 #define BOTAN_AES_H__
@@ -10,9 +10,9 @@
 
 namespace Botan {
 
-/*************************************************
-* AES                                            *
-*************************************************/
+/**
+* Rijndael aka AES
+*/
 class BOTAN_DLL AES : public BlockCipher
    {
    public:
@@ -36,9 +36,9 @@ class BOTAN_DLL AES : public BlockCipher
       u32bit ROUNDS;
    };
 
-/*************************************************
-* AES-128                                        *
-*************************************************/
+/**
+* AES-128
+*/
 class BOTAN_DLL AES_128 : public AES
    {
    public:
@@ -47,9 +47,9 @@ class BOTAN_DLL AES_128 : public AES
       AES_128() : AES(16) {}
    };
 
-/*************************************************
-* AES-192                                        *
-*************************************************/
+/**
+* AES-192
+*/
 class BOTAN_DLL AES_192 : public AES
    {
    public:
@@ -58,9 +58,9 @@ class BOTAN_DLL AES_192 : public AES
       AES_192() : AES(24) {}
    };
 
-/*************************************************
-* AES-256                                        *
-*************************************************/
+/**
+* AES-256
+*/
 class BOTAN_DLL AES_256 : public AES
    {
    public: