boostorg/algorithm
1
0
Fork 1
mirror of https://github.com/boostorg/algorithm.git synced 2026-08-06 13:34:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

[doc] Fix the parameter names documented for is_permutation

Browse Source 
The three-argument overload documents `\param last2`, but its parameters
are `first1`, `last1`, `first2` — `last2` is a local variable computed
inside the body. The four-argument overload right above it documents
`last1` correctly.

Both `\fn` lines also spell the first two parameters `first` and `last`
while the declarations use `first1` and `last1`.
This commit is contained in:
Anton Karpov
2026-08-03 16:52:44 +03:00
parent 175f443ee8
commit bdaee1f3f6
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/boost/algorithm/cxx11/is_permutation.hpp
+3 -3
View File
@@ -100,7 +100,7 @@ namespace detail {
}
/// \endcond
/// \fn is_permutation ( ForwardIterator1 first, ForwardIterator1 last, ForwardIterator2 first2, BinaryPredicate p )
/// \fn is_permutation ( ForwardIterator1 first1, ForwardIterator1 last1, ForwardIterator2 first2, BinaryPredicate p )
/// \brief Tests to see if the sequence [first,last) is a permutation of the sequence starting at first2
///
/// \param first1 The start of the input sequence
@@ -127,11 +127,11 @@ bool is_permutation ( ForwardIterator1 first1, ForwardIterator1 last1,
return true;
}
/// \fn is_permutation ( ForwardIterator1 first, ForwardIterator1 last, ForwardIterator2 first2 )
/// \fn is_permutation ( ForwardIterator1 first1, ForwardIterator1 last1, ForwardIterator2 first2 )
/// \brief Tests to see if the sequence [first,last) is a permutation of the sequence starting at first2
///
/// \param first1 The start of the input sequence
/// \param last2 One past the end of the input sequence
/// \param last1 One past the end of the input sequence
/// \param first2 The start of the second sequence
/// \note This function is part of the C++2011 standard library.
template< class ForwardIterator1, class ForwardIterator2 >