From 6673de0f17d6a7f2e1ee4c294bbd3ab7e452282f Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Sun, 27 Dec 2020 01:16:27 -0500 Subject: Update documentation --- config_int.h | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) (limited to 'config_int.h') diff --git a/config_int.h b/config_int.h index 672b1b77..f71efab8 100644 --- a/config_int.h +++ b/config_int.h @@ -79,7 +79,7 @@ typedef signed int sword32; /// \brief A 64-bit unsigned datatype /// \details The typedef for word64 varies depending on the platform. /// On Microsoft platforms it is unsigned __int64. On Unix & Linux - /// with LP64 data model it is unsigned long. On Unix & Linux with ILP32 + /// with LP64 data model it is unsigned long. On Unix & Linux with ILP32 /// data model it is unsigned long long. /// \since Crypto++ 1.0 typedef unsigned long long word64; @@ -87,11 +87,20 @@ typedef signed int sword32; /// \brief A 64-bit signed datatype /// \details The typedef for sword64 varies depending on the platform. /// On Microsoft platforms it is signed __int64. On Unix & Linux - /// with LP64 data model it is signed long. On Unix & Linux with ILP32 + /// with LP64 data model it is signed long. On Unix & Linux with ILP32 /// data model it is signed long long. /// \since Crypto++ 8.0 typedef signed long long sword64; + /// \brief A 128-bit unsigned datatype + /// \details The typedef for word128 varies depending on the platform. + /// word128 is only available on 64-bit machines when + /// CRYPTOPP_WORD128_AVAILABLE is defined. + /// On Unix & Linux with LP64 data model it is __uint128_t. + /// Microsoft platforms do not provide a 128-bit integer type. + /// \since Crypto++ 1.0 + typedef __uint128_t word128; + /// \brief How to declare an unsigned word64 /// \details W64LIT is used to portability declare or assign 64-bit literal values. /// Use the macro like shown below. @@ -156,8 +165,10 @@ const lword LWORD_MAX = W64LIT(0xffffffffffffffff); /// \brief Double word used for multiprecision integer arithmetic /// \details dword is used for multiprecision integer arithmetic. /// The typedef for dword varies depending on the platform. - /// On 32-bit platforms it is usually word64. On 64-bit platforms - /// it is usually word128. + /// On 32-bit platforms it is usually word64. On 64-bit Unix & + /// Linux platforms it is usually word128. word128 is + /// not available on Microsoft platforms. word128 is only available + /// when CRYPTOPP_WORD128_AVAILABLE is defined. /// \details Library users typically use byte, word16, word32 and word64. /// \sa CRYPTOPP_WORD128_AVAILABLE /// \since Crypto++ 2.0 -- cgit v1.2.1