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

Fix \fn and \param tags in the searching algorithms

include/boost/algorithm/cxx11/is_permutation.hpp

@@ -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 >

include/boost/algorithm/searching/boyer_moore.hpp

@@ -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>

include/boost/algorithm/searching/boyer_moore_horspool.hpp

@@ -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>

include/boost/algorithm/searching/knuth_morris_pratt.hpp

@@ -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
             

include/boost/algorithm/string/formatter.hpp

@@ -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.
         */