diff options
author | Philipp A. Hartmann <pah@qo.cx> | 2014-07-31 13:28:22 +0400 |
---|---|---|
committer | Philipp A. Hartmann <pah@qo.cx> | 2014-07-31 15:03:32 +0400 |
commit | 9a9c6d68109e79c8dbf836e91a6c0302af29105d (patch) | |
tree | 8f8612bc9ad451cfcb732c2901955fa97ca90506 /include | |
parent | 6ed9934143bdd5b144b4e38b73950f3ef25b6b1e (diff) |
GenericValue: improve Erase documentation
Diffstat (limited to 'include')
-rw-r--r-- | include/rapidjson/document.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/include/rapidjson/document.h b/include/rapidjson/document.h index 250c33e8..b7e35c8d 100644 --- a/include/rapidjson/document.h +++ b/include/rapidjson/document.h @@ -1008,7 +1008,7 @@ int z = a[0u].GetInt(); // This works too. //! Remove an element of array by iterator.
/*!
\param pos iterator to the element to remove
- \pre IsArray() == true
+ \pre IsArray() == true && \ref Begin() <= \c pos < \ref End()
\return Iterator following the removed element. If the iterator pos refers to the last element, the End() iterator is returned.
*/
ValueIterator Erase(ValueIterator pos) {
@@ -1017,10 +1017,10 @@ int z = a[0u].GetInt(); // This works too. //! Remove elements in the range [first, last) of the array.
/*!
- \param pos iterator to the element to remove
- \param first,last range of elements to remove
- \pre IsArray() == true
- \return Iterator following the last removed element. If the iterator pos refers to the last element, the End() iterator is returned.
+ \param first iterator to the first element to remove
+ \param last iterator following the last element to remove
+ \pre IsArray() == true && \ref Begin() <= \c first <= \c last <= \ref End()
+ \return Iterator following the last removed element.
*/
ValueIterator Erase(ValueIterator first, ValueIterator last) {
RAPIDJSON_ASSERT(IsArray());
|