diff options
author | Jeffrey Walton <noloader@gmail.com> | 2021-04-09 23:14:21 -0400 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2021-04-09 23:14:21 -0400 |
commit | a6bb071b739f0d41c76aec34e6106b9b990f15c4 (patch) | |
tree | 1a4d651c026366b1f3d6f025d81acab18a4f0f93 /secblock.h | |
parent | 89b4999adca15ca5f09f8f22766ab48fa3daf19e (diff) | |
download | cryptopp-git-a6bb071b739f0d41c76aec34e6106b9b990f15c4.tar.gz |
Update documentation
Diffstat (limited to 'secblock.h')
-rw-r--r-- | secblock.h | 9 |
1 files changed, 6 insertions, 3 deletions
@@ -888,7 +888,9 @@ public: /// \param ptr a pointer to an array of T
/// \param len the number of elements in the memory block
/// \details The array pointed to by <tt>ptr</tt> must be distinct
- /// from this SecBlock because Assign() calls New() and memcpy.
+ /// from this SecBlock because Assign() calls New() and then memcpy().
+ /// The call to New() will invalidate all pointers and iterators, like
+ /// the pointer returned from data().
/// \details If the memory block is reduced in size, then the reclaimed
/// memory is set to 0. If an assignment occurs, then Assign() resets
/// the element count after the previous block is zeroized.
@@ -939,8 +941,9 @@ public: /// \param len the number of elements in the memory block
/// \throw InvalidArgument if resulting size would overflow
/// \details The array pointed to by <tt>ptr</tt> must be distinct
- /// from this SecBlock because Append() calls Grow() and memcpy.
- /// \details Internally, this SecBlock calls Grow() and then appends t.
+ /// from this SecBlock because Append() calls Grow() and then memcpy().
+ /// The call to Grow() will invalidate all pointers and iterators, like
+ /// the pointer returned from data().
/// \details Append() may be less efficient than a ByteQueue because
/// Append() must Grow() the internal array and then copy elements.
/// The ByteQueue can copy elements without growing.
|