From 682ab78b019a06fca5dc0b3ba53ca126df6ddbd6 Mon Sep 17 00:00:00 2001
From: Jeffrey Walton <noloader@gmail.com>
Date: Sat, 19 Aug 2017 02:32:44 -0400
Subject: Update documentation

---
 secblock.h | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

(limited to 'secblock.h')

diff --git a/secblock.h b/secblock.h
index 4e17bb7d..f1177196 100644
--- a/secblock.h
+++ b/secblock.h
@@ -44,7 +44,9 @@ public:
 
 	//! \brief Returns the maximum number of elements the allocator can provide
 	//! \details <tt>ELEMS_MAX</tt> is the maximum number of elements the
-	//!   <tt>Allocator</tt> can provide.
+	//!   <tt>Allocator</tt> can provide. The value of <tt>ELEMS_MAX</tt> is
+	//!   <tt>SIZE_MAX/sizeof(T)</tt>. <tt>std::numeric_limits</tt> was avoided
+	//!   due to lack of <tt>constexpr</tt>-ness in C++03 and below.
 	//! \note In C++03 and below <tt>ELEMS_MAX</tt> is a static data member of type
 	//!   <tt>size_type</tt>. In C++11 and above <tt>ELEMS_MAX</tt> is an <tt>enum</tt>
 	//!   inheriting from <tt>size_type</tt>. In both cases <tt>ELEMS_MAX</tt> can be
@@ -52,7 +54,9 @@ public:
 	//!   limitations of class methods like <tt>max_size</tt>.
 	//! \sa <A HREF="http://github.com/weidai11/cryptopp/issues/346">Issue 346/CVE-2016-9939</A>
 	//! \since Crypto++ 6.0
-#if defined(CRYPTOPP_CXX11) && !defined(CRYPTOPP_DOXYGEN_PROCESSING)
+#if defined(CRYPTOPP_DOXYGEN_PROCESSING)
+	static const size_type ELEMS_MAX = ...;
+#elif defined(CRYPTOPP_CXX11)
 	enum : size_type {ELEMS_MAX = SIZE_MAX/sizeof(T)};
 #else
 	static const size_type ELEMS_MAX = SIZE_MAX/sizeof(T);
@@ -510,7 +514,9 @@ public:
 
 	//! \brief Returns the maximum number of elements the block can hold
 	//! \details <tt>ELEMS_MAX</tt> is the maximum number of elements the
-	//!   <tt>SecBlock</tt> can hold.
+	//!   <tt>SecBlock</tt> can hold. The value of <tt>ELEMS_MAX</tt> is
+	//!   <tt>SIZE_MAX/sizeof(T)</tt>. <tt>std::numeric_limits</tt> was avoided
+	//!   due to lack of <tt>constexpr</tt>-ness in C++03 and below.
 	//! \note In C++03 and below <tt>ELEMS_MAX</tt> is a static data member of type
 	//!   <tt>size_type</tt>. In C++11 and above <tt>ELEMS_MAX</tt> is an <tt>enum</tt>
 	//!   inheriting from <tt>size_type</tt>. In both cases <tt>ELEMS_MAX</tt> can be
@@ -518,8 +524,10 @@ public:
 	//!   limitations of class methods like <tt>max_size</tt>.
 	//! \sa <A HREF="http://github.com/weidai11/cryptopp/issues/346">Issue 346/CVE-2016-9939</A>
 	//! \since Crypto++ 6.0
-#if defined(CRYPTOPP_CXX11) && !defined(CRYPTOPP_DOXYGEN_PROCESSING)
-	enum : size_type { ELEMS_MAX = A::ELEMS_MAX };
+#if defined(CRYPTOPP_DOXYGEN_PROCESSING)
+	static const size_type ELEMS_MAX = ...;
+#elif defined(CRYPTOPP_CXX11)
+	enum : size_type {ELEMS_MAX = A::ELEMS_MAX};
 #else
 	static const size_type ELEMS_MAX = SIZE_MAX/sizeof(T);
 #endif
-- 
cgit v1.2.1