summaryrefslogtreecommitdiff
path: root/integer.h
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2016-11-14 03:48:21 -0500
committerJeffrey Walton <noloader@gmail.com>2016-11-14 03:48:21 -0500
commit1ba8142195ec498d9bd841e03ce94f5f9be876c0 (patch)
treec1200493224bba415cfb7c20b34762413c2980b6 /integer.h
parentf7df2de28428de43deaab2e79636d7151568c371 (diff)
downloadcryptopp-git-1ba8142195ec498d9bd841e03ce94f5f9be876c0.tar.gz
Guard XOR of optional xorBlock. Updated documentation
Diffstat (limited to 'integer.h')
-rw-r--r--integer.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/integer.h b/integer.h
index f289779a..e59b0a56 100644
--- a/integer.h
+++ b/integer.h
@@ -115,7 +115,7 @@ public:
//! \brief Convert from a C-string
//! \param str C-string value
- //! \param order byte order
+ //! \param order the ByteOrder of the string to be processed
//! \details \p str can be in base 2, 8, 10, or 16. Base is determined by a case
//! insensitive suffix of 'h', 'o', or 'b'. No suffix means base 10.
//! \details Byte order was added at Crypto++ 5.7 to allow use of little-endian
@@ -124,7 +124,7 @@ public:
//! \brief Convert from a wide C-string
//! \param str wide C-string value
- //! \param order byte order
+ //! \param order the ByteOrder of the string to be processed
//! \details \p str can be in base 2, 8, 10, or 16. Base is determined by a case
//! insensitive suffix of 'h', 'o', or 'b'. No suffix means base 10.
//! \details Byte order was added at Crypto++ 5.7 to allow use of little-endian
@@ -135,7 +135,7 @@ public:
//! \param encodedInteger big-endian byte array
//! \param byteCount length of the byte array
//! \param sign enumeration indicating Signedness
- //! \param order byte order
+ //! \param order the ByteOrder of the array to be processed
//! \details Byte order was added at Crypto++ 5.7 to allow use of little-endian
//! integers with curve25519, Poly1305 and Microsoft CAPI.
Integer(const byte *encodedInteger, size_t byteCount, Signedness sign=UNSIGNED, ByteOrder order = BIG_ENDIAN_ORDER);
@@ -144,7 +144,7 @@ public:
//! \param bt BufferedTransformation object with big-endian byte array
//! \param byteCount length of the byte array
//! \param sign enumeration indicating Signedness
- //! \param order byte order
+ //! \param order the ByteOrder of the data to be processed
//! \details Byte order was added at Crypto++ 5.7 to allow use of little-endian
//! integers with curve25519, Poly1305 and Microsoft CAPI.
Integer(BufferedTransformation &bt, size_t byteCount, Signedness sign=UNSIGNED, ByteOrder order = BIG_ENDIAN_ORDER);