[gcc r9-9370] libstdc++: Fix documentation for return values of copy algos
Jonathan Wakely
redi@gcc.gnu.org
Tue Apr 20 18:52:24 GMT 2021
https://gcc.gnu.org/g:053411d6d27564ec57b49e44f3ffec78cb3ecf5c
commit r9-9370-g053411d6d27564ec57b49e44f3ffec78cb3ecf5c
Author: Jonathan Wakely <jwakely@redhat.com>
Date: Mon Oct 12 18:14:01 2020 +0100
libstdc++: Fix documentation for return values of copy algos
The doxygen comments for these algos all incorrectly claim to use
(first - last) as the difference from the start of the output range to
the return value. As reported on the mailing list by Johannes Choo, it
should be (last - first).
libstdc++-v3/ChangeLog:
* include/bits/stl_algobase.h (copy, move, copy_backward)
(move_backward): Fix documentation for returned iterator.
(cherry picked from commit ae3967caffea9c9b9f0f9dfe42a4f59e715e1a61)
Diff:
---
libstdc++-v3/include/bits/stl_algobase.h | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/libstdc++-v3/include/bits/stl_algobase.h b/libstdc++-v3/include/bits/stl_algobase.h
index 6e9316a24cd..47423a8bcfa 100644
--- a/libstdc++-v3/include/bits/stl_algobase.h
+++ b/libstdc++-v3/include/bits/stl_algobase.h
@@ -449,7 +449,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
* @param __first An input iterator.
* @param __last An input iterator.
* @param __result An output iterator.
- * @return result + (first - last)
+ * @return result + (last - first)
*
* This inline function will boil down to a call to @c memmove whenever
* possible. Failing that, if random access iterators are passed, then the
@@ -481,7 +481,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
* @param __first An input iterator.
* @param __last An input iterator.
* @param __result An output iterator.
- * @return result + (first - last)
+ * @return result + (last - first)
*
* This inline function will boil down to a call to @c memmove whenever
* possible. Failing that, if random access iterators are passed, then the
@@ -624,7 +624,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
* @param __first A bidirectional iterator.
* @param __last A bidirectional iterator.
* @param __result A bidirectional iterator.
- * @return result - (first - last)
+ * @return result - (last - first)
*
* The function has the same effect as copy, but starts at the end of the
* range and works its way to the start, returning the start of the result.
@@ -659,7 +659,7 @@ _GLIBCXX_BEGIN_NAMESPACE_VERSION
* @param __first A bidirectional iterator.
* @param __last A bidirectional iterator.
* @param __result A bidirectional iterator.
- * @return result - (first - last)
+ * @return result - (last - first)
*
* The function has the same effect as move, but starts at the end of the
* range and works its way to the start, returning the start of the result.
More information about the Libstdc++-cvs
mailing list