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

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

1 files changed, 27 insertions, 27 deletions

diff --git a/sm4.h b/sm4.h
index 425192a2..906dad7e 100644
--- a/sm4.h
+++ b/sm4.h
@@ -1,12 +1,12 @@
 // sm4.h - written and placed in the public domain by Jeffrey Walton and Han Lulu

 

-//! \file sm4.h

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

-//! \details SM4 is a block cipher designed by Xiaoyun Wang, et al. The block cipher is part of the

-//!   Chinese State Cryptography Administration portfolio. The cipher was formely known as SMS4.

-//! \sa <A HREF="http://eprint.iacr.org/2008/329.pdf">SMS4 Encryption Algorithm for Wireless Networks</A> and

-//!   <A HREF="http://github.com/guanzhi/GmSSL">Reference implementation using OpenSSL</A>.

-//! \since Crypto++ 6.0

+/// \file sm4.h

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

+/// \details SM4 is a block cipher designed by Xiaoyun Wang, et al. The block cipher is part of the

+///   Chinese State Cryptography Administration portfolio. The cipher was formely known as SMS4.

+/// \sa <A HREF="http://eprint.iacr.org/2008/329.pdf">SMS4 Encryption Algorithm for Wireless Networks</A> and

+///   <A HREF="http://github.com/guanzhi/GmSSL">Reference implementation using OpenSSL</A>.

+/// \since Crypto++ 6.0

 

 #ifndef CRYPTOPP_SM4_H

 #define CRYPTOPP_SM4_H

@@ -17,9 +17,9 @@
 

 NAMESPACE_BEGIN(CryptoPP)

 

-//! \class SM4_Info

-//! \brief SM4 block cipher information

-//! \since Crypto++ 6.0

+/// \class SM4_Info

+/// \brief SM4 block cipher information

+/// \since Crypto++ 6.0

 struct SM4_Info : public FixedBlockSize<16>, FixedKeyLength<16>

 {

     static const std::string StaticAlgorithmName()

@@ -28,18 +28,18 @@ struct SM4_Info : public FixedBlockSize<16>, FixedKeyLength<16>
     }

 };

 

-//! \class SM4

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

-//! \details SM4 is a block cipher designed by Xiaoyun Wang, et al. The block cipher is part of the

-//!   Chinese State Cryptography Administration portfolio. The cipher was formely known as SMS4.

-//! \sa <A HREF="http://eprint.iacr.org/2008/329.pdf">SMS4 Encryption Algorithm for Wireless Networks</A>

-//! \since Crypto++ 6.0

+/// \class SM4

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

+/// \details SM4 is a block cipher designed by Xiaoyun Wang, et al. The block cipher is part of the

+///   Chinese State Cryptography Administration portfolio. The cipher was formely known as SMS4.

+/// \sa <A HREF="http://eprint.iacr.org/2008/329.pdf">SMS4 Encryption Algorithm for Wireless Networks</A>

+/// \since Crypto++ 6.0

 class CRYPTOPP_NO_VTABLE SM4 : public SM4_Info, public BlockCipherDocumentation

 {

 public:

-    //! \brief SM4 block cipher transformation functions

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

-    //! \since Crypto++ 6.0

+    /// \brief SM4 block cipher transformation functions

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

+    /// \since Crypto++ 6.0

     class CRYPTOPP_NO_VTABLE Base : public BlockCipherImpl<SM4_Info>

     {

     protected:

@@ -49,20 +49,20 @@ public:
         mutable SecBlock<word32, AllocatorWithCleanup<word32> > m_wspace;

     };

 

-    //! \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: