diff --git a/secblock.h b/secblock.h index 32a99363..4741685b 100644 --- a/secblock.h +++ b/secblock.h @@ -285,13 +285,15 @@ public: //! \class FixedSizeAllocatorWithCleanup //! \brief Static secure memory block with cleanup //! \tparam T class or type -//! \tparam S fixed-size of the stack-based memory block +//! \tparam S fixed-size of the stack-based memory block, in bytes //! \tparam A AllocatorBase derived class for allocation and cleanup //! \details FixedSizeAllocatorWithCleanup provides a fixed-size, stack- //! based allocation at compile time. The class can grow its memory //! block at runtime if a suitable allocator is available. If size //! grows beyond S and a suitable allocator is available, then the //! statically allocated array is obsoleted. +//! \note The size S is the number of bytes, and not count of elements. This is somewhat unique +//! among library allocators, and its due to the interactions with NullAllocator. //! \note This allocator can't be used with standard collections because //! they require that all objects of the same allocator type are equivalent. template , bool T_Align16 = false> @@ -761,8 +763,10 @@ public: //! \class FixedSizeAlignedSecBlock //! \brief Fixed size stack-based SecBlock with 16-byte alignment //! \tparam T class or type -//! \tparam S fixed-size of the stack-based memory block +//! \tparam S fixed-size of the stack-based memory block, in bytes //! \tparam A AllocatorBase derived class for allocation and cleanup +//! \note The size S is the number of bytes, and not count of elements. This is somewhat unique +//! among library allocators, and its due to the interactions with NullAllocator. template class FixedSizeAlignedSecBlock : public FixedSizeSecBlock, T_Align16> > { @@ -773,6 +777,8 @@ class FixedSizeAlignedSecBlock : public FixedSizeSecBlockS is the number of bytes, and not count of elements. This is somewhat unique +//! among library allocators, and its due to the interactions with NullAllocator. template > > class SecBlockWithHint : public SecBlock {