diff options
author | Jonathan Wakely <jwakely@redhat.com> | 2020-10-12 18:14:01 +0100 |
---|---|---|
committer | Jonathan Wakely <jwakely@redhat.com> | 2020-10-12 18:14:01 +0100 |
commit | ae3967caffea9c9b9f0f9dfe42a4f59e715e1a61 (patch) | |
tree | d59b19e0c1a70ae3c34c2f59cfbc5f7f586b020a | |
parent | 82118acc18e416b9c82c82ce7737f5e6246d6574 (diff) | |
download | gcc-ae3967caffea9c9b9f0f9dfe42a4f59e715e1a61.zip gcc-ae3967caffea9c9b9f0f9dfe42a4f59e715e1a61.tar.gz gcc-ae3967caffea9c9b9f0f9dfe42a4f59e715e1a61.tar.bz2 |
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.
-rw-r--r-- | libstdc++-v3/include/bits/stl_algobase.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/libstdc++-v3/include/bits/stl_algobase.h b/libstdc++-v3/include/bits/stl_algobase.h index 3e9ec32..d19f688 100644 --- a/libstdc++-v3/include/bits/stl_algobase.h +++ b/libstdc++-v3/include/bits/stl_algobase.h @@ -594,7 +594,7 @@ _GLIBCXX_END_NAMESPACE_CONTAINER * @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 @@ -627,7 +627,7 @@ _GLIBCXX_END_NAMESPACE_CONTAINER * @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 @@ -830,7 +830,7 @@ _GLIBCXX_END_NAMESPACE_CONTAINER * @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. @@ -866,7 +866,7 @@ _GLIBCXX_END_NAMESPACE_CONTAINER * @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. |