summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2018-07-13 09:54:06 -0400
committerJeffrey Walton <noloader@gmail.com>2018-07-13 09:54:06 -0400
commit380829284c41d3cebff05dfd03c1eb4dbc95bf7a (patch)
tree735e79587765811ea8d28ecfa8755b335180f720
parent678bdb1735409b2e0a6727959e9f97f785fd19da (diff)
downloadcryptopp-git-380829284c41d3cebff05dfd03c1eb4dbc95bf7a.tar.gz
Update documentation
-rw-r--r--cham.h8
-rw-r--r--hight.h4
-rw-r--r--lea.h4
-rw-r--r--rijndael.h4
-rw-r--r--shacal2.h4
-rw-r--r--simeck.h8
-rw-r--r--simon.h8
-rw-r--r--sm4.h4
-rw-r--r--speck.h8
-rw-r--r--threefish.h12
10 files changed, 32 insertions, 32 deletions
diff --git a/cham.h b/cham.h
index 8931f468..1b2a9b3d 100644
--- a/cham.h
+++ b/cham.h
@@ -67,7 +67,7 @@ public:
unsigned int m_kw;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 7.1
@@ -81,7 +81,7 @@ public:
#endif
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 7.1
@@ -126,7 +126,7 @@ public:
unsigned int m_kw;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 7.1
@@ -140,7 +140,7 @@ public:
#endif
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 7.1
diff --git a/hight.h b/hight.h
index 6af94e3e..fc8cd160 100644
--- a/hight.h
+++ b/hight.h
@@ -51,7 +51,7 @@ public:
mutable FixedSizeSecBlock<word32, 8> m_xx;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation.
/// \since Crypto++ 7.1
class CRYPTOPP_NO_VTABLE Enc : public Base
@@ -60,7 +60,7 @@ public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation.
/// \since Crypto++ 7.1
class CRYPTOPP_NO_VTABLE Dec : public Base
diff --git a/lea.h b/lea.h
index 5d10e02a..1c4019c9 100644
--- a/lea.h
+++ b/lea.h
@@ -56,7 +56,7 @@ public:
unsigned int m_rounds;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 7.1
@@ -70,7 +70,7 @@ public:
#endif
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 7.1
diff --git a/rijndael.h b/rijndael.h
index 4a23b979..325c3114 100644
--- a/rijndael.h
+++ b/rijndael.h
@@ -62,7 +62,7 @@ class CRYPTOPP_DLL Rijndael : public Rijndael_Info, public BlockCipherDocumentat
mutable SecByteBlock m_aliasBlock;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key sizes are supported.
/// The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks
/// \since Rijndael since Crypto++ 3.1, Intel AES-NI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
@@ -76,7 +76,7 @@ class CRYPTOPP_DLL Rijndael : public Rijndael_Info, public BlockCipherDocumentat
#endif
};
- /// \brief Provides implementation for decryption transformation
+ /// \brief Decryption transformation
/// \details Dec provides implementation for decryption transformation. All key sizes are supported.
/// The library only provides Rijndael with 128-bit blocks, and not 192-bit or 256-bit blocks
/// \since Rijndael since Crypto++ 3.1, Intel AES-NI since Crypto++ 5.6.1, ARMv8 AES since Crypto++ 6.0,
diff --git a/shacal2.h b/shacal2.h
index 20cb306c..7be2d279 100644
--- a/shacal2.h
+++ b/shacal2.h
@@ -37,7 +37,7 @@ class SHACAL2 : public SHACAL2_Info, public BlockCipherDocumentation
};
/// \brief SHACAL2 block cipher transformation functions
- /// \details Provides implementation for encryption transformation
+ /// \details Encryption transformation
class CRYPTOPP_NO_VTABLE Enc : public Base
{
public:
@@ -45,7 +45,7 @@ class SHACAL2 : public SHACAL2_Info, public BlockCipherDocumentation
};
/// \brief SHACAL2 block cipher transformation functions
- /// \details Provides implementation for decryption transformation
+ /// \details Decryption transformation
class CRYPTOPP_NO_VTABLE Dec : public Base
{
public:
diff --git a/simeck.h b/simeck.h
index ca106797..74914945 100644
--- a/simeck.h
+++ b/simeck.h
@@ -68,7 +68,7 @@ public:
mutable FixedSizeSecBlock<word16, 5> m_t;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 7.1
@@ -78,7 +78,7 @@ public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 7.1
@@ -118,7 +118,7 @@ public:
mutable FixedSizeSecBlock<word32, 5> m_t;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 7.1
@@ -132,7 +132,7 @@ public:
#endif
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 7.1
diff --git a/simon.h b/simon.h
index 4e6c7fe5..4a6d0609 100644
--- a/simon.h
+++ b/simon.h
@@ -90,7 +90,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -103,7 +103,7 @@ public:
#endif
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -149,7 +149,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -162,7 +162,7 @@ public:
#endif
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key
/// sizes are supported.
/// \since Crypto++ 6.0
diff --git a/sm4.h b/sm4.h
index 16395ff8..18f10bd6 100644
--- a/sm4.h
+++ b/sm4.h
@@ -54,7 +54,7 @@ public:
mutable SecBlock<word32, AllocatorWithCleanup<word32> > m_wspace;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key
/// sizes are supported.
/// \details SM4 encryption is accelerated on machines with AES-NI. Decryption is
@@ -72,7 +72,7 @@ public:
#endif
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key
/// sizes are supported.
/// \details SM4 encryption is accelerated on machines with AES-NI. Decryption is
diff --git a/speck.h b/speck.h
index 2e2dc144..7ed7517e 100644
--- a/speck.h
+++ b/speck.h
@@ -90,7 +90,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -103,7 +103,7 @@ public:
#endif
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -149,7 +149,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -162,7 +162,7 @@ public:
#endif
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key
/// sizes are supported.
/// \since Crypto++ 6.0
diff --git a/threefish.h b/threefish.h
index fd1f6e40..d98c93ff 100644
--- a/threefish.h
+++ b/threefish.h
@@ -81,7 +81,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -91,7 +91,7 @@ public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -125,7 +125,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -135,7 +135,7 @@ public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -169,7 +169,7 @@ public:
void UncheckedSetKey(const byte *userKey, unsigned int keyLength, const NameValuePairs &params);
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Enc provides implementation for encryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 6.0
@@ -179,7 +179,7 @@ public:
void ProcessAndXorBlock(const byte *inBlock, const byte *xorBlock, byte *outBlock) const;
};
- /// \brief Provides implementation for encryption transformation
+ /// \brief Encryption transformation
/// \details Dec provides implementation for decryption transformation. All key and block
/// sizes are supported.
/// \since Crypto++ 6.0