Change Doxygen comment style from //! to ///

Also see https://groups.google.com/forum/#!topic/cryptopp-users/A7-Xt5Knlzw

1 files changed, 63 insertions, 63 deletions

diff --git a/speck.h b/speck.h
index 108c82ec..ef78fb10 100644
--- a/speck.h
+++ b/speck.h
@@ -1,13 +1,13 @@
 // speck.h - written and placed in the public domain by Jeffrey Walton

 

-//! \file speck.h

-//! \brief Classes for the Speck block cipher

-//! \details Speck is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith,

-//!   Stefan Treatman-Clark, Bryan Weeks and Louis Wingers.

-//! \sa <A HREF="http://eprint.iacr.org/2013/404">The SIMON and SPECK Families of

-//!   Lightweight Block Ciphers</A> and <A HREF="http://iadgov.github.io/simon-speck/">

-//!   The Simon and Speck GitHub</A>

-//! \since Crypto++ 6.0

+/// \file speck.h

+/// \brief Classes for the Speck block cipher

+/// \details Speck is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith,

+///   Stefan Treatman-Clark, Bryan Weeks and Louis Wingers.

+/// \sa <A HREF="http://eprint.iacr.org/2013/404">The SIMON and SPECK Families of

+///   Lightweight Block Ciphers</A> and <A HREF="http://iadgov.github.io/simon-speck/">

+///   The Simon and Speck GitHub</A>

+/// \since Crypto++ 6.0

 

 #ifndef CRYPTOPP_SPECK_H

 #define CRYPTOPP_SPECK_H

@@ -22,13 +22,13 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class SPECK_Info

-//! \brief SPECK block cipher information

-//! \tparam L block size of the cipher, in bytes

-//! \tparam D default key length, in bytes

-//! \tparam N minimum key length, in bytes

-//! \tparam M maximum key length, in bytes

-//! \since Crypto++ 6.0

+/// \class SPECK_Info

+/// \brief SPECK block cipher information

+/// \tparam L block size of the cipher, in bytes

+/// \tparam D default key length, in bytes

+/// \tparam N minimum key length, in bytes

+/// \tparam M maximum key length, in bytes

+/// \since Crypto++ 6.0

 template <unsigned int L, unsigned int D, unsigned int N, unsigned int M>

 struct SPECK_Info : public FixedBlockSize<L>, VariableKeyLength<D, N, M>

 {

@@ -39,12 +39,12 @@ struct SPECK_Info : public FixedBlockSize<L>, VariableKeyLength<D, N, M>
     }

 };

 

-//! \class SPECK_Base

-//! \brief SPECK block cipher base class

-//! \tparam W the word type

-//! \details User code should use SPECK64 or SPECK128

-//! \sa SPECK64, SPECK128, <a href="http://www.cryptopp.com/wiki/SPECK">SPECK</a>

-//! \since Crypto++ 6.0

+/// \class SPECK_Base

+/// \brief SPECK block cipher base class

+/// \tparam W the word type

+/// \details User code should use SPECK64 or SPECK128

+/// \sa SPECK64, SPECK128, <a href="http://www.cryptopp.com/wiki/SPECK">SPECK</a>

+/// \since Crypto++ 6.0

 template <class W>

 struct SPECK_Base

 {

@@ -58,22 +58,22 @@ struct SPECK_Base
     unsigned int            m_rounds;  // number of rounds

 };

 

-//! \class SPECK64

-//! \brief SPECK 64-bit block cipher

-//! \details Speck is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith,

-//!   Stefan Treatman-Clark, Bryan Weeks and Louis Wingers.

-//! \details SPECK64 provides 64-bit block size. The valid key sizes are 96-bit and 128-bit.

-//! \sa SPECK64, SPECK128,  <A HREF="http://eprint.iacr.org/2013/404">The SIMON and SPECK

-//!   Families of Lightweight Block Ciphers</A>, <A HREF="http://iadgov.github.io/simon-speck/">

-//!   The Simon and Speck GitHub</A>, <a href="http://www.cryptopp.com/wiki/SPECK">SPECK</a> on the

-//!   Crypto++ wiki

-//! \since Crypto++ 6.0

+/// \class SPECK64

+/// \brief SPECK 64-bit block cipher

+/// \details Speck is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith,

+///   Stefan Treatman-Clark, Bryan Weeks and Louis Wingers.

+/// \details SPECK64 provides 64-bit block size. The valid key sizes are 96-bit and 128-bit.

+/// \sa SPECK64, SPECK128,  <A HREF="http://eprint.iacr.org/2013/404">The SIMON and SPECK

+///   Families of Lightweight Block Ciphers</A>, <A HREF="http://iadgov.github.io/simon-speck/">

+///   The Simon and Speck GitHub</A>, <a href="http://www.cryptopp.com/wiki/SPECK">SPECK</a> on the

+///   Crypto++ wiki

+/// \since Crypto++ 6.0

 class CRYPTOPP_NO_VTABLE SPECK64 : public SPECK_Info<8, 12, 12, 16>, public BlockCipherDocumentation

 {

 public:

-    //! \brief SPECK block cipher transformation functions

-    //! \details Provides implementation common to encryption and decryption

-    //! \since Crypto++ 6.0

+    /// \brief SPECK block cipher transformation functions

+    /// \details Provides implementation common to encryption and decryption

+    /// \since Crypto++ 6.0

     class CRYPTOPP_NO_VTABLE Base : protected SPECK_Base<word32>, public BlockCipherImpl<SPECK_Info<8, 12, 12, 16> >

     {

     public:

@@ -86,20 +86,20 @@ public:
         void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);

     };

 

-    //! \brief Provides implementation for encryption transformation

-    //! \details Enc provides implementation for encryption transformation. All key

-    //!   sizes are supported.

-    //! \since Crypto++ 6.0

+    /// \brief Provides implementation for encryption transformation

+    /// \details Enc provides implementation for encryption transformation. All key

+    ///   sizes are supported.

+    /// \since Crypto++ 6.0

     class CRYPTOPP_NO_VTABLE Enc : public Base

     {

     protected:

         void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;

     };

 

-    //! \brief Provides implementation for encryption transformation

-    //! \details Dec provides implementation for decryption transformation. All key

-    //!   sizes are supported.

-    //! \since Crypto++ 6.0

+    /// \brief Provides implementation for encryption transformation

+    /// \details Dec provides implementation for decryption transformation. All key

+    ///   sizes are supported.

+    /// \since Crypto++ 6.0

     class CRYPTOPP_NO_VTABLE Dec : public Base

     {

     protected:

@@ -110,22 +110,22 @@ public:
     typedef BlockCipherFinal<DECRYPTION, Dec> Decryption;

 };

 

-//! \class SPECK128

-//! \brief SPECK 128-bit block cipher

-//! \details Speck is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith,

-//!   Stefan Treatman-Clark, Bryan Weeks and Louis Wingers.

-//! \details SPECK128 provides 128-bit block size. The valid key sizes are 128-bit, 192-bit and 256-bit.

-//! \sa SPECK64, SPECK128,  <A HREF="http://eprint.iacr.org/2013/404">The SIMON and SPECK

-//!   Families of Lightweight Block Ciphers</A>, <A HREF="http://iadgov.github.io/simon-speck/">

-//!   The Simon and Speck GitHub</A>, <a href="http://www.cryptopp.com/wiki/SPECK">SPECK</a> on the

-//!   Crypto++ wiki

-//! \since Crypto++ 6.0

+/// \class SPECK128

+/// \brief SPECK 128-bit block cipher

+/// \details Speck is a block cipher designed by Ray Beaulieu, Douglas Shors, Jason Smith,

+///   Stefan Treatman-Clark, Bryan Weeks and Louis Wingers.

+/// \details SPECK128 provides 128-bit block size. The valid key sizes are 128-bit, 192-bit and 256-bit.

+/// \sa SPECK64, SPECK128,  <A HREF="http://eprint.iacr.org/2013/404">The SIMON and SPECK

+///   Families of Lightweight Block Ciphers</A>, <A HREF="http://iadgov.github.io/simon-speck/">

+///   The Simon and Speck GitHub</A>, <a href="http://www.cryptopp.com/wiki/SPECK">SPECK</a> on the

+///   Crypto++ wiki

+/// \since Crypto++ 6.0

 class CRYPTOPP_NO_VTABLE SPECK128 : public SPECK_Info<16, 16, 16, 32>, public BlockCipherDocumentation

 {

 public:

-    //! \brief SPECK block cipher transformation functions

-    //! \details Provides implementation common to encryption and decryption

-    //! \since Crypto++ 6.0

+    /// \brief SPECK block cipher transformation functions

+    /// \details Provides implementation common to encryption and decryption

+    /// \since Crypto++ 6.0

     class CRYPTOPP_NO_VTABLE Base : protected SPECK_Base<word64>, public BlockCipherImpl<SPECK_Info<16, 16, 16, 32> >

     {

     public:

@@ -138,10 +138,10 @@ public:
         void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);

     };

 

-    //! \brief Provides implementation for encryption transformation

-    //! \details Enc provides implementation for encryption transformation. All key

-    //!   sizes are supported.

-    //! \since Crypto++ 6.0

+    /// \brief Provides implementation for encryption transformation

+    /// \details Enc provides implementation for encryption transformation. All key

+    ///   sizes are supported.

+    /// \since Crypto++ 6.0

     class CRYPTOPP_NO_VTABLE Enc : public Base

     {

     protected:

@@ -151,10 +151,10 @@ public:
 #endif

     };

 

-    //! \brief Provides implementation for encryption transformation

-    //! \details Dec provides implementation for decryption transformation. All key

-    //!   sizes are supported.

-    //! \since Crypto++ 6.0

+    /// \brief Provides implementation for encryption transformation

+    /// \details Dec provides implementation for decryption transformation. All key

+    ///   sizes are supported.

+    /// \since Crypto++ 6.0

     class CRYPTOPP_NO_VTABLE Dec : public Base

     {

     protected: