Compare commits

...

3 Commits

Author SHA1 Message Date
Marshall Clow b738d228bf Remove name of unnamed parameter in doxygen comment for 2026-08-03 21:40:27 -07:00
Marshall Clow bbb84882cd Merge pull request #131 from karpovantonme/doc-is-permutation-param-names
[doc] Fix the parameter names documented for is_permutation
2026-08-03 21:34:47 -07:00
Anton Karpov bdaee1f3f6 [doc] Fix the parameter names documented for is_permutation
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`.
2026-08-03 16:52:44 +03:00
2 changed files with 4 additions and 4 deletions
@@ -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 >
+1 -1
View File
@@ -75,7 +75,7 @@ namespace boost {
Constructs an \c empty_formatter. Empty formatter always returns an empty
sequence.
\param Input container used to select a correct value_type for the
\param - container used to select a correct value_type for the
resulting empty_container<>.
\return An instance of the \c empty_formatter object.
*/