Merge pull request #132 from karpovantonme/docs/searching-param-tags

Fix \fn and \param tags in the searching algorithms
2026-08-06 05:24:07 +02:00 · 2026-08-04 21:29:36 -07:00 · 2026-08-05 06:16:33 +03:00 · 2026-08-03 21:40:27 -07:00 · 2026-08-03 21:34:47 -07:00 · 2026-08-03 16:52:44 +03:00
5 changed files with 12 additions and 15 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 >
@@ -108,12 +108,11 @@ Requirements:
        typename traits::skip_table_t skip_;
        std::vector <difference_type> suffix_;

-        /// \fn operator ( corpusIter corpus_first, corpusIter corpus_last, Pred p )
+        /// \fn do_search ( corpusIter corpus_first, corpusIter corpus_last )
        /// \brief Searches the corpus for the pattern that was passed into the constructor
-        /// 
+        ///
        /// \param corpus_first The start of the data to search (Random Access Iterator)
        /// \param corpus_last  One past the end of the data to search
-        /// \param p            A predicate used for the search comparisons.
        ///
        template <typename corpusIter>
        std::pair<corpusIter, corpusIter>
@@ -107,7 +107,6 @@ http://www-igm.univ-mlv.fr/%7Elecroq/string/node18.html
        /// 
        /// \param corpus_first The start of the data to search (Random Access Iterator)
        /// \param corpus_last  One past the end of the data to search
-        /// \param k_corpus_length The length of the corpus to search
        ///
        template <typename corpusIter>
        std::pair<corpusIter, corpusIter>
@@ -62,12 +62,11 @@ namespace boost { namespace algorithm {
            
        ~knuth_morris_pratt () {}
        
-        /// \fn operator ( corpusIter corpus_first, corpusIter corpus_last, Pred p )
+        /// \fn operator ( corpusIter corpus_first, corpusIter corpus_last )
        /// \brief Searches the corpus for the pattern that was passed into the constructor
-        /// 
+        ///
        /// \param corpus_first The start of the data to search (Random Access Iterator)
        /// \param corpus_last  One past the end of the data to search
-        /// \param p            A predicate used for the search comparisons.
        ///
        template <typename corpusIter>
        std::pair<corpusIter, corpusIter>
@@ -99,16 +98,16 @@ namespace boost { namespace algorithm {
        const difference_type k_pattern_length;
        std::vector <difference_type> skip_;

-        /// \fn operator ( corpusIter corpus_first, corpusIter corpus_last, Pred p )
+        /// \fn do_search ( corpusIter corpus_first, corpusIter corpus_last, difference_type k_corpus_length )
        /// \brief Searches the corpus for the pattern that was passed into the constructor
-        /// 
+        ///
        /// \param corpus_first The start of the data to search (Random Access Iterator)
        /// \param corpus_last  One past the end of the data to search
-        /// \param p            A predicate used for the search comparisons.
+        /// \param k_corpus_length The length of the corpus to search
        ///
        template <typename corpusIter>
        std::pair<corpusIter, corpusIter>
-        do_search ( corpusIter corpus_first, corpusIter corpus_last, 
+        do_search ( corpusIter corpus_first, corpusIter corpus_last,
                                                difference_type k_corpus_length ) const {
            difference_type match_start = 0;  // position in the corpus that we're matching
            
@@ -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.
        */
Author	SHA1	Message	Date
Marshall Clow	cfc892ccbe	Merge pull request #132 from karpovantonme/docs/searching-param-tags Fix \fn and \param tags in the searching algorithms	2026-08-04 21:29:36 -07:00
Anton Karpov	db783f5815	Fix \fn and \param tags in the searching algorithms The four searchers share copied comment blocks, and three of them kept names from a function they no longer describe. boyer_moore and knuth_morris_pratt document a predicate parameter Pred p that none of the operators or do_search overloads take. boyer_moore also names the block \fn operator while it sits on do_search, and so does one of the two blocks in knuth_morris_pratt, where the real third parameter is k_corpus_length rather than p. boyer_moore_horspool documents k_corpus_length on a do_search that takes two arguments. The correct form is already in the same family: boyer_moore.hpp:73 and boyer_moore_horspool.hpp:68 both name two parameters and no predicate.	2026-08-05 06:16:33 +03:00
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