documentation update.

added remarks about the exception safety


[SVN r23558]
This commit is contained in:
Pavol Droba
2004-07-14 21:28:31 +00:00
parent caad29f22a
commit 8cf6df3ad6
10 changed files with 320 additions and 68 deletions

View File

@ -47,6 +47,10 @@ namespace boost {
\return
An output iterator pointing just after last inserted character or
a copy of the input
\note If the input paramters satisfy the second assumption
about exception safety, the second variant of this function provides strong
exception guarantie.
*/
template<typename OutputIteratorT, typename CollectionT, typename PredicateT>
inline OutputIteratorT trim_left_copy_if(
@ -88,6 +92,10 @@ namespace boost {
\param Input An input sequence
\param Loc a locale used for 'space' classification
\return A trimmed copy of the input
\note If the input paramters satisfy the second assumption
about exception safety, this function provides strong
exception guarantie.
*/
template<typename SequenceT>
inline SequenceT trim_left_copy(const SequenceT& Input, const std::locale& Loc=std::locale())
@ -149,6 +157,10 @@ namespace boost {
\return
An output iterator pointing just after last inserted character or
a copy of the input
\note If the input paramters satisfy the second assumption
about exception safety, the second variant of this function provides strong
exception guarantie.
*/
template<typename OutputIteratorT, typename CollectionT, typename PredicateT>
inline OutputIteratorT trim_right_copy_if(
@ -191,6 +203,10 @@ namespace boost {
\param Input An input sequence
\param Loc A locale used for 'space' classification
\return A trimmed copy of the input
\note If the input paramters satisfy second assumption
about exception safety, this function provides strong
exception guarantie.
*/
template<typename SequenceT>
inline SequenceT trim_right_copy(const SequenceT& Input, const std::locale& Loc=std::locale())
@ -255,6 +271,10 @@ namespace boost {
\return
An output iterator pointing just after last inserted character or
a copy of the input
\note If the input paramters satisfy the second assumption
about exception safety, the second variant of this function provides strong
exception guarantie.
*/
template<typename OutputIteratorT, typename CollectionT, typename PredicateT>
inline OutputIteratorT trim_copy_if(
@ -310,6 +330,10 @@ namespace boost {
\param Input An input sequence
\param Loc A locale used for 'space' classification
\return A trimmed copy of the input
\note If the input paramters satisfy the second assumption
about exception safety, this function provides strong
exception guarantie.
*/
template<typename SequenceT>
inline SequenceT trim_copy( const SequenceT& Input, const std::locale& Loc=std::locale() )