summaryrefslogtreecommitdiff
path: root/include/stdalgo.h
diff options
context:
space:
mode:
authorSadie Powell <sadie@witchery.services>2021-03-31 10:38:54 +0100
committerSadie Powell <sadie@witchery.services>2021-03-31 10:51:51 +0100
commit952ee5cc603a5231348b8cfab18ee85a097f5394 (patch)
treeaf56b96d229f931ace18fcf69a35614b5921e289 /include/stdalgo.h
parent8c3c4f8e8274a598b4ba573f9eabfd0940d2e88d (diff)
Fix various documentation comments.
Diffstat (limited to 'include/stdalgo.h')
-rw-r--r--include/stdalgo.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/stdalgo.h b/include/stdalgo.h
index c0baa9dd8..585114fce 100644
--- a/include/stdalgo.h
+++ b/include/stdalgo.h
@@ -28,10 +28,10 @@ namespace stdalgo
* Erase a single element from a vector by overwriting it with a copy of the last element,
* which is then removed. This, in contrast to vector::erase(), does not result in all
* elements after the erased element being moved.
+ * Returns nothing, but all iterators, references and pointers to the erased element and the
+ * last element are invalidated
* @param vect Vector to remove the element from
* @param it Iterator to the element to remove
- * @return Nothing, but all iterators, references and pointers to the erased element and the
- * last element are invalidated
*/
template <typename T>
inline void swaperase(typename std::vector<T>& vect, const typename std::vector<T>::iterator& it)