arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation

pull/174/head
Jeffrey Walton 2016-05-19 14:37:50 -04:00
parent c8e1923515
commit 1c8c16f9e8
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
secblock.h
View File

@ -304,7 +304,7 @@ public:
FixedSizeAllocatorWithCleanup() : m_allocated(false) {} FixedSizeAllocatorWithCleanup() : m_allocated(false) {}
//! \brief Allocates a block of memory //! \brief Allocates a block of memory
//! \param size size of the memory block //! \param size size of the memory block, in bytes
//! \details FixedSizeAllocatorWithCleanup provides a fixed-size, stack- //! \details FixedSizeAllocatorWithCleanup provides a fixed-size, stack-
//! based allocation at compile time. If size is less than or equal to //! based allocation at compile time. If size is less than or equal to
//! S, then a pointer to the static array is returned. //! S, then a pointer to the static array is returned.
@ -314,7 +314,8 @@ public:
//! obsoleted. If a suitable allocator is \a not available, as with a //! obsoleted. If a suitable allocator is \a not available, as with a
//! NullAllocator, then the function returns NULL and a runtime error //! NullAllocator, then the function returns NULL and a runtime error
//! eventually occurs. //! eventually occurs.
//! \note size is the count of elements, and not the number of bytes. //! \note size is the number of bytes, and not count of elements. This is somewhat unique among
//! library allocators, and its due to the interactions with <tt>NullAllocator<T></tt>.
//! \sa reallocate(), SecBlockWithHint //! \sa reallocate(), SecBlockWithHint
pointer allocate(size_type size) pointer allocate(size_type size)
{ {
@ -330,7 +331,7 @@ public:
} }
//! \brief Allocates a block of memory //! \brief Allocates a block of memory
//! \param size size of the memory block //! \param size size of the memory block, in bytes
//! \param hint an unused hint //! \param hint an unused hint
//! \details FixedSizeAllocatorWithCleanup provides a fixed-size, stack- //! \details FixedSizeAllocatorWithCleanup provides a fixed-size, stack-
//! based allocation at compile time. If size is less than or equal to //! based allocation at compile time. If size is less than or equal to
@ -341,7 +342,8 @@ public:
//! obsoleted. If a suitable allocator is \a not available, as with a //! obsoleted. If a suitable allocator is \a not available, as with a
//! NullAllocator, then the function returns NULL and a runtime error //! NullAllocator, then the function returns NULL and a runtime error
//! eventually occurs. //! eventually occurs.
//! \note size is the count of elements, and not the number of bytes. //! \note size is the number of bytes, and not count of elements. This is somewhat unique among
//! library allocators, and its due to the interactions with <tt>NullAllocator<T></tt>.
//! \sa reallocate(), SecBlockWithHint //! \sa reallocate(), SecBlockWithHint
pointer allocate(size_type size, const void *hint) pointer allocate(size_type size, const void *hint)
{ {