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

@@ -38,15 +38,15 @@ namespace boost {
/*!
Remove all leading spaces from the input. Supplied predicate
is used to determine which character is a space.
The result is a trimmed copy if the input. It is returned as a sequence
or copied to an output iterator
The result is a trimmed 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 collection
\param IsSpace An unary predicate identifying spaces
\return
An output iterator pointing just after last inserted character or
a copy of the input
An output iterator pointing just after last inserted character or
a copy of the input
*/
template<typename OutputIteratorT, typename CollectionT, typename PredicateT>
inline OutputIteratorT trim_left_copy_if(
@@ -67,8 +67,8 @@ namespace boost {
//! Left trim - parametric
/*!
\overload
*/
\overload
*/
template<typename SequenceT, typename PredicateT>
inline SequenceT trim_left_copy_if(const SequenceT& Input, PredicateT IsSpace)
{
@@ -83,11 +83,11 @@ namespace boost {
//! Left trim - parametric
/*!
Remove all leading spaces from the input.
The result is a trimmed copy if the input.
The result is a trimmed copy of the input.
\param Input An input sequence
\param Loc a locale used for 'space' classification
\return A trimmed copy if the input
\return A trimmed copy of the input
*/
template<typename SequenceT>
inline SequenceT trim_left_copy(const SequenceT& Input, const std::locale& Loc=std::locale())
@@ -140,15 +140,15 @@ namespace boost {
/*!
Remove all trailing spaces from the input. Supplied predicate
is used to determine which character is a space.
The result is a trimmed copy if the input. It is returned as a sequence
or copied to an output iterator
The result is a trimmed 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 collection
\param IsSpace An unary predicate identifying spaces
\return
An output iterator pointing just after last inserted character or
a copy of the input
An output iterator pointing just after last inserted character or
a copy of the input
*/
template<typename OutputIteratorT, typename CollectionT, typename PredicateT>
inline OutputIteratorT trim_right_copy_if(
@@ -169,7 +169,7 @@ namespace boost {
//! Right trim - parametric
/*!
\overload
\overload
*/
template<typename SequenceT, typename PredicateT>
inline SequenceT trim_right_copy_if(const SequenceT& Input, PredicateT IsSpace)
@@ -186,11 +186,11 @@ namespace boost {
//! Right trim
/*!
Remove all trailing spaces from the input.
The result is a trimmed copy if the input
The result is a trimmed copy of the input
\param Input An input sequence
\param Loc A locale used for 'space' classification
\return A trimmed copy if the input
\return A trimmed copy of the input
*/
template<typename SequenceT>
inline SequenceT trim_right_copy(const SequenceT& Input, const std::locale& Loc=std::locale())
@@ -246,15 +246,15 @@ namespace boost {
/*!
Remove all trailing and leading spaces from the input.
Supplied predicate is used to determine which character is a space.
The result is a trimmed copy if the input. It is returned as a sequence
or copied to an output iterator
The result is a trimmed 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 collection
\param IsSpace An unary predicate identifying spaces
\return
An output iterator pointing just after last inserted character or
a copy of the input
An output iterator pointing just after last inserted character or
a copy of the input
*/
template<typename OutputIteratorT, typename CollectionT, typename PredicateT>
inline OutputIteratorT trim_copy_if(
@@ -281,7 +281,7 @@ namespace boost {
//! Trim - parametric
/*!
\overload
\overload
*/
template<typename SequenceT, typename PredicateT>
inline SequenceT trim_copy_if(const SequenceT& Input, PredicateT IsSpace)
@@ -305,11 +305,11 @@ namespace boost {
//! Trim
/*!
Remove all leading and trailing spaces from the input.
The result is a trimmed copy if the input
The result is a trimmed copy of the input
\param Input An input sequence
\param Loc A locale used for 'space' classification
\return A trimmed copy if the input
\return A trimmed copy of the input
*/
template<typename SequenceT>
inline SequenceT trim_copy( const SequenceT& Input, const std::locale& Loc=std::locale() )