Comments cleanup

[SVN r23447]
This commit is contained in:
Pavol Droba
2004-07-11 22:07:00 +00:00
parent 22b59d1848
commit 029851b0ce
14 changed files with 493 additions and 624 deletions

View File

@ -30,14 +30,16 @@ namespace boost {
//! Replace range algorithm
/*!
Substitute the given range in the input sequence with the
format sequence. The result is copied to the given output iterator.
Replace the given range in the input string.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Input An input string
\param SearchRange A range in the input to be substituted
\param Format A substitute sequence
\return An output iterator pointing just after last inserted character
\param Format A substitute string
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -60,13 +62,7 @@ namespace boost {
//! Replace range algorithm
/*!
Substitute a given range in the input sequence with the
format sequence. The result is a modified copy of the input.
\param Input An input sequence
\param SearchRange A range in the input to be substituted
\param Format A substitute sequence
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT replace_range_copy(
@ -84,12 +80,12 @@ namespace boost {
//! Replace range algorithm
/*!
Substitute a given range in the input sequence with the
format sequence. The input sequence is modified in-place.
Replace the given range in the input string.
The input sequence is modified in-place.
\param Input An input sequence
\param Input An input string
\param SearchRange A range in the input to be substituted
\param Format A substitute sequence
\param Format A substitute string
*/
template<typename SequenceT, typename CollectionT>
inline void replace_range(
@ -109,14 +105,17 @@ namespace boost {
//! Replace first algorithm
/*!
Substitute a first match of the search sequence in the input
with the format sequence. The result is copied to the given output iterator.
Replace the first match of the search string in the input
with the format string.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\return An output iterator pointing just after last inserted character
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -138,13 +137,7 @@ namespace boost {
//! Replace first algorithm
/*!
Substitute a first match of the search sequence in the input
with the format sequence. The result is a modified copy of the input.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
inline SequenceT replace_first_copy(
@ -160,12 +153,12 @@ namespace boost {
//! Replace first algorithm
/*!
Substitute a first match of the search sequence in the input
with the format sequence. The input sequence is modified in-place.
replace the first match of the search string in the input
with the format string. The input sequence is modified in-place.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
inline void replace_first(
@ -183,16 +176,19 @@ namespace boost {
//! Replace first algorithm ( case insensitive )
/*!
Substitute a first match of the search sequence in the input
with the format sequence. The result is a modified copy of the input.
Replace the first match of the search string in the input
with the format string.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
Searching is case insensitive.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
\param Loc a locale used for case insensitive comparison
\return A modified copy of the input
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -213,17 +209,9 @@ namespace boost {
const_formatter(Format) );
}
//! Replace first algorithm ( case insensitive )
//! Replace first algorithm ( case insensitive )
/*!
Substitute a first match of the search sequence in the input
with the format sequence. The result is copied to the given output iterator.
Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Loc a locale used for case insensitive comparison
\return An output iterator pointing just after last inserted character
\overload
*/
template<typename SequenceT, typename Collection2T, typename Collection1T>
inline SequenceT ireplace_first_copy(
@ -240,13 +228,13 @@ namespace boost {
//! Replace first algorithm ( case insensitive )
/*!
Substitute a first match of the search sequence in the input
with the format sequence. Input sequence is modified in-place.
Replace the first match of the search string in the input
with the format string. Input sequence is modified in-place.
Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
\param Loc a locale used for case insensitive comparison
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
@ -266,14 +254,17 @@ namespace boost {
//! Replace last algorithm
/*!
Substitute a last match of the search sequence in the input
with the format sequence. The result is copied to the given output iterator.
Replace the last match of the search string in the input
with the format string.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\return An output iterator pointing just after last inserted character
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -295,13 +286,7 @@ namespace boost {
//! Replace last algorithm
/*!
Substitute a last match of the search sequence in the input
with the format sequence. The result is a modified copy of the input.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
inline SequenceT replace_last_copy(
@ -317,12 +302,12 @@ namespace boost {
//! Replace last algorithm
/*!
Substitute a last match of the search sequence in the input
with the format sequence. Input sequence is modified in-place.
Replace the last match of the search string in the input
with the format string. Input sequence is modified in-place.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
inline void replace_last(
@ -340,16 +325,19 @@ namespace boost {
//! Replace last algorithm ( case insensitive )
/*!
Substitute a last match of the search sequence in the input
with the format sequence. The result is copied to the given output iterator.
Replace the last match of the search string in the input
with the format string.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
Searching is case insensitive.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
\param Loc a locale used for case insensitive comparison
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -372,15 +360,7 @@ namespace boost {
//! Replace last algorithm ( case insensitive )
/*!
Substitute a last match of the search sequence in the input
with the format sequence. The result is a modified copy of the input.
Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Loc a locale used for case insensitive comparison
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
inline SequenceT ireplace_last_copy(
@ -397,13 +377,13 @@ namespace boost {
//! Replace last algorithm ( case insensitive )
/*!
Substitute a last match of the search sequence in the input
with the format sequence.The input sequence is modified in-place.
Replace the last match of the search string in the input
with the format string.The input sequence is modified in-place.
Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
\param Loc a locale used for case insensitive comparison
\return A reference to the modified input
*/
@ -424,15 +404,18 @@ namespace boost {
//! Replace nth algorithm
/*!
Substitute an Nth match of the search sequence in the input
with the format sequence. The result is copied to the given output iterator.
Replace an Nth (zero-indexed) match of the search string in the input
with the format string.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
\param Nth An index of the match to be replaced. The index is 0-based.
\param Format A substitute sequence
\return An output iterator pointing just after last inserted character
\param Format A substitute string
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -455,14 +438,7 @@ namespace boost {
//! Replace nth algorithm
/*!
Substitute an Nth match of the search sequence in the input
with the format sequence. The result is a modified copy of the input.
\param Input An input sequence
\param Search A string to be searched for.
\param Nth An index of the match to be replaced. The index is 0-based.
\param Format A substitute sequence
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
inline SequenceT replace_nth_copy(
@ -479,13 +455,13 @@ namespace boost {
//! Replace nth algorithm
/*!
Substitute an Nth match of the search sequence in the input
with the format sequence. Input sequence is modified in-place.
Replace an Nth (zero-indexed) match of the search string in the input
with the format string. Input sequence is modified in-place.
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
\param Nth An index of the match to be replaced. The index is 0-based.
\param Format A substitute sequence
\param Format A substitute string
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
inline void replace_nth(
@ -504,17 +480,20 @@ namespace boost {
//! Replace nth algorithm ( case insensitive )
/*!
Substitute an Nth match of the search sequence in the input
with the format sequence. The result is copied to the given output iterator.
Replace an Nth (zero-indexed) match of the search string in the input
with the format string.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
Searching is case insensitive.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
\param Nth An index of the match to be replaced. The index is 0-based.
\param Format A substitute sequence
\param Format A substitute string
\param Loc a locale used for case insensitive comparison
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -538,16 +517,7 @@ namespace boost {
//! Replace nth algorithm ( case insensitive )
/*!
Substitute an Nth match of the search sequence in the input
with the format sequence. The result is a modified copy of the input.
Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Nth An index of the match to be replaced. The index is 0-based.
\param Format A substitute sequence
\param Loc a locale used for case insensitive comparison
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
inline SequenceT ireplace_nth_copy(
@ -565,14 +535,14 @@ namespace boost {
//! Replace nth algorithm ( case insensitive )
/*!
Substitute an Nth match of the search sequence in the input
with the format sequence. Input sequence is modified in-place.
Replace an Nth (zero-indexed) match of the search string in the input
with the format string. Input sequence is modified in-place.
Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Input An input string
\param Search A string to be searched for
\param Nth An index of the match to be replaced. The index is 0-based.
\param Format A substitute sequence
\param Format A substitute string
\param Loc a locale used for case insensitive comparison
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
@ -593,14 +563,17 @@ namespace boost {
//! Replace all algorithm
/*!
Substitute all occurrences of the search sequence in the input
with the format sequence. The result is copied to the given output iterator.
Replace all occurrences of the search string in the input
with the format string.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\return An output iterator pointing just after last inserted character
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -622,13 +595,7 @@ namespace boost {
//! Replace all algorithm
/*!
Substitute all occurrences of the search sequence in the input
with the format sequence. The result is a modified copy of the input.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
inline SequenceT replace_all_copy(
@ -644,12 +611,12 @@ namespace boost {
//! Replace all algorithm
/*!
Substitute all occurrences of the search sequence in the input
with the format sequence. The input sequence is modified in-place.
Replace all occurrences of the search string in the input
with the format string. The input sequence is modified in-place.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
\return A reference to the modified input
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
@ -668,16 +635,19 @@ namespace boost {
//! Replace all algorithm ( case insensitive )
/*!
Substitute all occurrences of the search sequence in the input
with the format sequence. The result is copied to the given output iterator.
Replace all occurrences of the search string in the input
with the format string.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
Searching is case insensitive.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
\param Loc a locale used for case insensitive comparison
\return An output iterator pointing just after last inserted character
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -700,15 +670,7 @@ namespace boost {
//! Replace all algorithm ( case insensitive )
/*!
Substitute all occurrences of the search sequence in the input
with the format sequence. The result is a modified copy of the input.
Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Loc a locale used for case insensitive comparison
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
inline SequenceT ireplace_all_copy(
@ -725,13 +687,13 @@ namespace boost {
//! Replace all algorithm ( case insensitive )
/*!
Substitute all occurrences of the search sequence in the input
with the format sequence.The input sequence is modified in-place.
Replace all occurrences of the search string in the input
with the format string.The input sequence is modified in-place.
Searching is case insensitive.
\param Input An input sequence
\param Search A string to be searched for.
\param Format A substitute sequence
\param Input An input string
\param Search A string to be searched for
\param Format A substitute string
\param Loc a locale used for case insensitive comparison
*/
template<typename SequenceT, typename Collection1T, typename Collection2T>
@ -751,16 +713,19 @@ namespace boost {
//! Replace head algorithm
/*!
Replace the head of the input with the given format sequence.
Head is a prefix of a seqence of given size.
If the sequence is shorter then required, whole sequence if
considered to be the head. The result is copied to the given output iterator.
Replace the head of the input with the given format string.
Head is a prefix of a string of given size.
If the sequence is shorter then required, whole string if
considered to be the head.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Input An input string
\param N A length of the head
\param Format A substitute sequence
\return An output iterator pointing just after last inserted character
\param Format A substitute string
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -781,15 +746,7 @@ namespace boost {
//! Replace head algorithm
/*!
Replace the head of the input with the given format sequence.
Head is a prefix of a seqence of given size.
If the sequence is shorter then required, whole sequence if
considered to be the head. The result is a modified copy of the input.
\param Input An input sequence
\param N A length of the head
\param Format A substitute sequence
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT replace_head_copy(
@ -805,14 +762,14 @@ namespace boost {
//! Replace head algorithm
/*!
Replace the head of the input with the given format sequence.
Head is a prefix of a seqence of given size.
Replace the head of the input with the given format string.
Head is a prefix of a string of given size.
If the sequence is shorter then required, whole sequence if
considered to be the head. The input sequence is modified in-place.
\param Input An input sequence
\param Input An input string
\param N A length of the head
\param Format A substitute sequence
\param Format A substitute string
*/
template<typename SequenceT, typename CollectionT>
inline void replace_head(
@ -830,16 +787,19 @@ namespace boost {
//! Replace tail algorithm
/*!
Replace the tail of the input with the given format sequence.
Tail is a suffix of a seqence of given size.
If the sequence is shorter then required, whole sequence if
considered to be the tail. The result is copied to the given output iterator.
Replace the tail of the input with the given format string.
Tail is a suffix of a string of given size.
If the sequence is shorter then required, whole string if
considered to be the tail.
The result is a modified copy of the input. It is returned as a sequence
or copied to an output iterator.
\param Output A output iterator to which the result will be copied
\param Input An input sequence
\param Input An input string
\param N A length of the head
\param Format A substitute sequence
\return An output iterator pointing just after last inserted character
\param Format A substitute string
\return An output iterator pointing just after last inserted character or
a modified copy of the input
*/
template<
typename OutputIteratorT,
@ -860,15 +820,7 @@ namespace boost {
//! Replace tail algorithm
/*!
Replace the tail of the input with the given format sequence.
Tail is a suffix of a seqence of given size.
If the sequence is shorter then required, whole sequence is
considered to be the tail. The result is a modified copy of the input.
\param Input An input sequence
\param N A length of the head
\param Format A substitute sequence
\return A modified copy of the input
\overload
*/
template<typename SequenceT, typename CollectionT>
inline SequenceT replace_tail_copy(
@ -885,13 +837,13 @@ namespace boost {
//! Replace tail algorithm
/*!
Replace the tail of the input with the given format sequence.
Tail is a suffix of a seqence of given size.
If the sequence is shorter then required, whole sequence is
Tail is a suffix of a string of given size.
If the sequence is shorter then required, whole string is
considered to be the tail. The input sequence is modified in-place.
\param Input An input sequence
\param Input An input string
\param N A length of the head
\param Format A substitute sequence
\param Format A substitute string
*/
template<typename SequenceT, typename CollectionT>
inline void replace_tail(