Cleanup header docs

jakcron · Dec 30, 2024 · 7d24067 · 7d24067
1 parent 777a850
commit 7d24067
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 10 deletions.
diff --git a/include/tc/crypto/CmacAes128Generator.h b/include/tc/crypto/CmacAes128Generator.h
@@ -17,7 +17,7 @@ namespace tc { namespace crypto {
 	 * @brief Class for calculating CMAC-AES-128.
 	 * 
 	 * @details This class calcualtes CMAC using AES-128.
-	 * For more information refer to @ref HmacGenerator.
+	 * For more information refer to @ref CmacGenerator.
 	 */
 using CmacAes128Generator = CmacGenerator<Aes128Encryptor>;
 

diff --git a/include/tc/crypto/CmacAes192Generator.h b/include/tc/crypto/CmacAes192Generator.h
@@ -17,7 +17,7 @@ namespace tc { namespace crypto {
 	 * @brief Class for calculating CMAC-AES-192.
 	 * 
 	 * @details This class calcualtes CMAC using AES-192.
-	 * For more information refer to @ref HmacGenerator.
+	 * For more information refer to @ref CmacGenerator.
 	 */
 using CmacAes192Generator = CmacGenerator<Aes192Encryptor>;
 

diff --git a/include/tc/crypto/CmacAes256Generator.h b/include/tc/crypto/CmacAes256Generator.h
@@ -17,7 +17,7 @@ namespace tc { namespace crypto {
 	 * @brief Class for calculating CMAC-AES-256.
 	 * 
 	 * @details This class calcualtes CMAC using AES-256.
-	 * For more information refer to @ref HmacGenerator.
+	 * For more information refer to @ref CmacGenerator.
 	 */
 using CmacAes256Generator = CmacGenerator<Aes256Encryptor>;
 

diff --git a/include/tc/crypto/CmacGenerator.h b/include/tc/crypto/CmacGenerator.h
@@ -15,7 +15,7 @@ namespace tc { namespace crypto {
 	 * @class CmacGenerator
 	 * @brief Class for calculating an CMAC.
 	 * 
-	 * @tparam BlockCipher The class that implements the hash function for generating CMAC.
+	 * @tparam BlockCipher The class that implements the CBC encryption operation for generating MAC.
 	 * 
 	 * @details
 	 * This class is a template class that takes a hash function implementation class as template parameter.

diff --git a/include/tc/crypto/CmacTdes112Generator.h b/include/tc/crypto/CmacTdes112Generator.h
@@ -17,7 +17,7 @@ namespace tc { namespace crypto {
 	 * @brief Class for calculating CMAC-TDES-112.
 	 * 
 	 * @details This class calcualtes CMAC using TDES-112.
-	 * For more information refer to @ref HmacGenerator.
+	 * For more information refer to @ref CmacGenerator.
 	 */
 using CmacTdes112Generator = CmacGenerator<Tdes112Encryptor>;
 

diff --git a/include/tc/crypto/CmacTdes168Generator.h b/include/tc/crypto/CmacTdes168Generator.h
@@ -17,7 +17,7 @@ namespace tc { namespace crypto {
 	 * @brief Class for calculating CMAC-TDES-168.
 	 * 
 	 * @details This class calcualtes CMAC using TDES-168.
-	 * For more information refer to @ref HmacGenerator.
+	 * For more information refer to @ref CmacGenerator.
 	 */
 using CmacTdes168Generator = CmacGenerator<Tdes168Encryptor>;
 

diff --git a/include/tc/crypto/detail/CmacImpl.h b/include/tc/crypto/detail/CmacImpl.h
@@ -3,7 +3,7 @@
 	 * @brief Declaration of tc::crypto::detail::CmacImpl
 	 * @author Jack (jakcron)
 	 * @version 0.1
-	 * @date 2022/07/12
+	 * @date 2024/12/10
 	 **/
 #pragma once
 #include <tc/types.h>
@@ -20,9 +20,9 @@ namespace tc { namespace crypto { namespace detail {
 
 	/**
 	 * @class CmacImpl
-	 * @brief This class implements the CMAC (<b>C</b>ounter with <b>C</b>BC-<b>M</b>AC) algorithm as a template class.
+	 * @brief This class implements the CMAC (<b>C</b>ipher based <b>MAC</b>) algorithm as a template class.
 	 * 
-	 * @tparam BlockCipher The class that implements the block cipher used for CCM mode encryption/decryption.
+	 * @tparam BlockCipher The class that implements the block cipher used for CBC encryption for generating MAC.
 	 * 
 	 * @details
 	 * The implementation of <var>BlockCipher</var> must satisfies the following conditions.

diff --git a/include/tc/crypto/detail/HmacImpl.h b/include/tc/crypto/detail/HmacImpl.h
@@ -13,7 +13,7 @@ namespace tc { namespace crypto { namespace detail {
 
 	/**
 	 * @class HmacImpl
-	 * @brief This class implements HMAC as a template class.
+	 * @brief This class implements HMAC (<b>H</b>ash based <b>MAC</b>) as a template class.
 	 * 
 	 * @tparam HashFunction The class that implements the hash function used for HMAC calculation.
 	 */