|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r55345 - in sandbox/SOC/2009/unicode: boost/iterator boost/unicode libs/unicode/example
From: loufoque_at_[hidden]
Date: 2009-08-01 12:58:18
Author: mgaunard
Date: 2009-08-01 12:58:17 EDT (Sat, 01 Aug 2009)
New Revision: 55345
URL: http://svn.boost.org/trac/boost/changeset/55345
Log:
Adding references to concept in doxygen descriptions
Text files modified:
sandbox/SOC/2009/unicode/boost/iterator/consumer_iterator.hpp | 16 +++++++----
sandbox/SOC/2009/unicode/boost/iterator/pipe_iterator.hpp | 7 +++--
sandbox/SOC/2009/unicode/boost/unicode/compose.hpp | 5 ++-
sandbox/SOC/2009/unicode/boost/unicode/graphemes.hpp | 7 +++--
sandbox/SOC/2009/unicode/boost/unicode/hangul.hpp | 12 +++++---
sandbox/SOC/2009/unicode/boost/unicode/utf.hpp | 22 ++++++++--------
sandbox/SOC/2009/unicode/boost/unicode/utf_codecs.hpp | 52 +++++++++++++++++++++------------------
sandbox/SOC/2009/unicode/libs/unicode/example/Jamfile.v2 | 14 ++++++---
8 files changed, 76 insertions(+), 59 deletions(-)
Modified: sandbox/SOC/2009/unicode/boost/iterator/consumer_iterator.hpp
==============================================================================
--- sandbox/SOC/2009/unicode/boost/iterator/consumer_iterator.hpp (original)
+++ sandbox/SOC/2009/unicode/boost/iterator/consumer_iterator.hpp 2009-08-01 12:58:17 EDT (Sat, 01 Aug 2009)
@@ -12,7 +12,8 @@
namespace boost
{
-/** Model of \c Consumer constructed from a model of \c Pipe */
+/** Model of \c \xmlonly<conceptname>Consumer</conceptname>\endxmlonly
+ * constructed from a model of \c \xmlonly<conceptname>Pipe</conceptname>\endxmlonly. */
template<typename Pipe>
struct pipe_consumer : private Pipe
{
@@ -48,7 +49,8 @@
return pipe_consumer<Pipe>(p);
}
-/** Model of \c Consumer constructed from a model of \c BoundaryChecker */
+/** Model of \c \xmlonly<conceptname>Consumer</conceptname>\endxmlonly
+ * constructed from a model of \c \xmlonly<conceptname>BoundaryChecker</conceptname>\endxmlonly. */
template<typename BoundaryChecker>
struct boundary_consumer : private BoundaryChecker
{
@@ -94,8 +96,9 @@
return boundary_consumer<BoundaryChecker>(b);
}
-/** Model of \c BoundaryChecker constructed from two models of \c BoundaryChecker
- * with a model of \c Pipe applied in the middle. */
+/** Model of \c \xmlonly<conceptname>BoundaryChecker</conceptname>\endxmlonly
+ * constructed from two models of \c \xmlonly<conceptname>BoundaryChecker</conceptname>\endxmlonly
+ * with a model of \c \xmlonly<conceptname>Pipe</conceptname>\endxmlonly applied in the middle. */
template<typename B1, typename Pipe, typename B2>
struct multi_boundary
{
@@ -146,8 +149,9 @@
return multi_boundary<B1, Pipe, B2>(b1, p, b2);
}
-/** Model of \c Consumer that adapts the elements another \c Consumer
- * sees with a model of \c Pipe. */
+/** Model of \c \xmlonly<conceptname>Consumer</conceptname>\endxmlonly
+ * that adapts the elements another \c \xmlonly<conceptname>Consumer</conceptname>\endxmlonly
+ * sees with a model of \c \xmlonly<conceptname>Pipe</conceptname>\endxmlonly. */
template<typename Pipe, typename Consumer>
struct piped_consumer
{
Modified: sandbox/SOC/2009/unicode/boost/iterator/pipe_iterator.hpp
==============================================================================
--- sandbox/SOC/2009/unicode/boost/iterator/pipe_iterator.hpp (original)
+++ sandbox/SOC/2009/unicode/boost/iterator/pipe_iterator.hpp 2009-08-01 12:58:17 EDT (Sat, 01 Aug 2009)
@@ -15,7 +15,8 @@
namespace boost
{
-/** Model of \c Pipe constructed from a model of \c OneManyPipe */
+/** Model of \c \xmlonly<conceptname>Pipe</conceptname>\endxmlonly
+ * constructed from a model of \c \xmlonly<conceptname>OneManyPipe</conceptname>\endxmlonly. */
template<typename OneManyPipe>
struct one_many_pipe : OneManyPipe
{
@@ -57,8 +58,8 @@
return one_many_pipe<OneManyPipe>(p);
}
-/** Model of \c OneManyPipe that casts its input to its template
- * parameter and writes it to its output. */
+/** Model of \c \xmlonly<conceptname>OneManyPipe</conceptname>\endxmlonly
+ * that casts its input to its template parameter and writes it to its output. */
template<typename T>
struct cast_pipe
{
Modified: sandbox/SOC/2009/unicode/boost/unicode/compose.hpp
==============================================================================
--- sandbox/SOC/2009/unicode/boost/unicode/compose.hpp (original)
+++ sandbox/SOC/2009/unicode/boost/unicode/compose.hpp 2009-08-01 12:58:17 EDT (Sat, 01 Aug 2009)
@@ -17,8 +17,9 @@
#undef BOOST_UNICODE_OPTION
#endif
-/** Model of \c OneManyPipe that decomposes a code point, i.e. it
- * converts a code point into a sequence of code points.
+/** Model of \c \xmlonly<conceptname>OneManyPipe</conceptname>\endxmlonly
+ * that decomposes a code point, i.e. it converts a code point into a
+ * sequence of code points.
* It applies UCD decompositions that match \c mask as well as the Hangul decompositions. */
template<unsigned mask = BOOST_UNICODE_OPTION(ucd::decomposition_type::canonical)>
struct decomposer
Modified: sandbox/SOC/2009/unicode/boost/unicode/graphemes.hpp
==============================================================================
--- sandbox/SOC/2009/unicode/boost/unicode/graphemes.hpp (original)
+++ sandbox/SOC/2009/unicode/boost/unicode/graphemes.hpp 2009-08-01 12:58:17 EDT (Sat, 01 Aug 2009)
@@ -22,7 +22,7 @@
} // namespace detail
-/** Model of \c BoundaryChecker that tells whether a position lies on a
+/** Model of \c \xmlonly<conceptname>BoundaryChecker</conceptname>\endxmlonly that tells whether a position lies on a
* grapheme cluster boundary within a range of code points. */
struct grapheme_boundary
{
@@ -113,8 +113,9 @@
); \
} \
\
-/** Model of \c BoundaryChecker that tells whether a position lies on a
-grapheme cluster boundary within a range of Name units. */ \
+/** Model of \c \xmlonly<conceptname>BoundaryChecker</conceptname>\endxmlonly
+that tells whether a position lies on a grapheme cluster boundary
+within a range of Name units. */ \
typedef multi_boundary< \
Name##_boundary, Name##_decoder, \
grapheme_boundary \
Modified: sandbox/SOC/2009/unicode/boost/unicode/hangul.hpp
==============================================================================
--- sandbox/SOC/2009/unicode/boost/unicode/hangul.hpp (original)
+++ sandbox/SOC/2009/unicode/boost/unicode/hangul.hpp 2009-08-01 12:58:17 EDT (Sat, 01 Aug 2009)
@@ -26,8 +26,9 @@
static const char32 SCount = LCount * NCount; // 11172
}
-/** \c OneManyPipe that transforms a single Hangul syllable (LV or LVT)
- * into its decomposed form since those decompositions are not part of the UCD.
+/** \c \xmlonly<conceptname>OneManyPipe</conceptname>\endxmlonly that
+ * transforms a single Hangul syllable (LV or LVT) into its decomposed
+ * form since those decompositions are not part of the UCD.
* Other code points are left unchanged. */
struct hangul_decomposer
{
@@ -60,9 +61,10 @@
};
-/** \c Pipe that transforms <L, V> and <LV, T> Hangul code points sequences
- * into the LV and LVT Hangul syllables, since those compositions
- * are not part of the UCD.
+/** \c \xmlonly<conceptname>Pipe</conceptname>\endxmlonly that
+ * transforms <L, V> and <LV, T> Hangul code points sequences into the
+ * LV and LVT Hangul syllables, since those compositions are not part
+ * of the UCD.
* Other code points are left unchanged. */
struct hangul_composer
{
Modified: sandbox/SOC/2009/unicode/boost/unicode/utf.hpp
==============================================================================
--- sandbox/SOC/2009/unicode/boost/unicode/utf.hpp (original)
+++ sandbox/SOC/2009/unicode/boost/unicode/utf.hpp 2009-08-01 12:58:17 EDT (Sat, 01 Aug 2009)
@@ -14,7 +14,7 @@
/** INTERNAL ONLY */
#define BOOST_UNICODE_ENCODER_DEF(Name) \
-/** Eagerly evaluates unicode::Name##_encoder until the whole input
+/** Eagerly evaluates \c unicode::##Name##_encoder until the whole input
range \c range has been treated, copying the result to \c out and
returning the past-the-end output iterator */ \
template<typename Range, typename OutputIterator> \
@@ -26,8 +26,8 @@
); \
} \
\
-/** Lazily evalutes unicode::Name##_encoder by returning a range adapter
- that wraps the range \c range and converts it step-by-step as
+/** Lazily evalutes \c unicode::##Name##_encoder by returning a range
+ adapter that wraps the range \c range and converts it step-by-step as
the range is advanced */ \
template<typename Range> \
iterator_range<typename boost::detail::unspecified< \
@@ -41,8 +41,8 @@
return piped(range, make_one_many_pipe(unicode::Name##_encoder()));\
} \
\
-/** Lazily evalutes unicode::Name##_encoder by returning a range adapter
- that wraps the range \c range and converts it step-by-step as
+/** Lazily evalutes \c unicode::##Name##_encoder by returning a range
+ adapter that wraps the range \c range and converts it step-by-step as
the range is advanced */ \
template<typename Range> \
iterator_range<typename boost::detail::unspecified< \
@@ -56,7 +56,7 @@
return piped(range, make_one_many_pipe(unicode::Name##_encoder()));\
} \
\
-/** Lazily evalutes unicode::Name##_encoder by returning an output
+/** Lazily evalutes \c unicode::##Name##_encoder by returning an output
iterator that wraps \c out and converts every pushed element. */ \
template<typename OutputIterator> \
typename boost::detail::unspecified<pipe_output_iterator< \
@@ -72,7 +72,7 @@
/** INTERNAL ONLY */
#define BOOST_UNICODE_DECODER_DEF(Name) \
-/** Eagerly evaluates unicode::Name##_decoder until the whole input
+/** Eagerly evaluates \c unicode::##Name##_decoder until the whole input
range \c range has been treated, copying the result to \c out and
returning the past-the-end output iterator */ \
template<typename Range, typename OutputIterator> \
@@ -81,8 +81,8 @@
return pipe(range, unicode::Name##_decoder(), out); \
} \
\
-/** Lazily evalutes unicode::Name##_decoder by returning a range adapter
- that wraps the range \c range and converts it step-by-step as
+/** Lazily evalutes \c unicode::##Name##_decoder by returning a range
+ adapter that wraps the range \c range and converts it step-by-step as
the range is advanced */ \
template<typename Range> \
iterator_range<typename boost::detail::unspecified< \
@@ -96,8 +96,8 @@
return piped(range, unicode::Name##_decoder()); \
} \
\
-/** Lazily evalutes unicode::Name##_decoder by returning a range adapter
- that wraps the range \c range and converts it step-by-step as
+/** Lazily evalutes \c unicode::##Name##_decoder by returning a range
+ adapter that wraps the range \c range and converts it step-by-step as
the range is advanced */ \
template<typename Range> \
iterator_range<typename boost::detail::unspecified< \
Modified: sandbox/SOC/2009/unicode/boost/unicode/utf_codecs.hpp
==============================================================================
--- sandbox/SOC/2009/unicode/boost/unicode/utf_codecs.hpp (original)
+++ sandbox/SOC/2009/unicode/boost/unicode/utf_codecs.hpp 2009-08-01 12:58:17 EDT (Sat, 01 Aug 2009)
@@ -76,15 +76,15 @@
} // namespace detail
-/** Model of \c OneManyPipe that converts a code point to a sequence
- * of UTF-16 code units. */
+/** Model of \c \xmlonly<conceptname>OneManyPipe</conceptname>\endxmlonly
+ * that converts a code point to a sequence of UTF-16 code units. */
struct u16_encoder
{
typedef char32 input_type;
typedef char16 output_type;
typedef mpl::int_<2> max_output;
- /** Throws std::out_of_range if \c v is not a valid code point. */
+ /** Throws \c std::out_of_range if \c v is not a valid code point. */
template<typename OutputIterator>
OutputIterator operator()(char32 v, OutputIterator out)
{
@@ -119,15 +119,15 @@
}
};
-/** Model of \c Pipe that converts a sequence of UTF-16 code units into
- * a single code point. */
+/** Model of \c \xmlonly<conceptname>Pipe</conceptname>\endxmlonly that
+ * converts a sequence of UTF-16 code units into a single code point. */
struct u16_decoder
{
typedef char16 input_type;
typedef char32 output_type;
typedef mpl::int_<1> max_output;
- /** Throws std::out_of_range if [<tt>begin</tt>, <tt>end</tt>[ is not a valid UTF-16 range. */
+ /** Throws \c std::out_of_range if [<tt>begin</tt>, <tt>end</tt>[ is not a valid UTF-16 range. */
template<typename In, typename Out>
std::pair<In, Out>
ltr(In begin, In end, Out out)
@@ -157,7 +157,7 @@
return std::make_pair(++it, out);
}
- /** Throws std::out_of_range if [<tt>begin</tt>, <tt>end</tt>[ is not a valid UTF-16 range. */
+ /** Throws \c std::out_of_range if [<tt>begin</tt>, <tt>end</tt>[ is not a valid UTF-16 range. */
template<typename In, typename Out>
std::pair<In, Out>
rtl(In begin, In end, Out out)
@@ -197,8 +197,9 @@
}
};
-/** Model of \c BoundaryChecker that tells whether a position lies on a code
- * point boundary within a range of UTF-16 code units. */
+/** Model of \c \xmlonly<conceptname>BoundaryChecker</conceptname>\endxmlonly
+ * that tells whether a position lies on a code point boundary within
+ * a range of UTF-16 code units. */
struct u16_boundary
{
typedef char16 input_type;
@@ -214,15 +215,15 @@
}
};
-/** Model of \c OneManyPipe that converts a code point to a sequence
- * of UTF-8 code units. */
+/** Model of \c \xmlonly<conceptname>OneManyPipe</conceptname>\endxmlonly
+ * that converts a code point to a sequence of UTF-8 code units. */
struct u8_encoder
{
typedef char32 input_type;
typedef char output_type;
typedef mpl::int_<4> max_output;
- /** Throws std::out_of_range if \c c is not a valid code point. */
+ /** Throws \c std::out_of_range if \c c is not a valid code point. */
template<typename OutputIterator>
OutputIterator operator()(char32 c, OutputIterator out)
{
@@ -256,8 +257,8 @@
}
};
-/** Model of \c Pipe that converts a sequence of UTF-8 code units into
- * a single code point. */
+/** Model of \c \xmlonly<conceptname>Pipe</conceptname>\endxmlonly that
+ * converts a sequence of UTF-8 code units into a single code point. */
struct u8_decoder
{
typedef char input_type;
@@ -273,7 +274,7 @@
}
public:
- /** Throws std::out_of_range if [<tt>begin</tt>, <tt>end</tt>[ is not a valid UTF-8 range. */
+ /** Throws \c std::out_of_range if [<tt>begin</tt>, <tt>end</tt>[ is not a valid UTF-8 range. */
template<typename In, typename Out>
std::pair<In, Out>
ltr(In begin, In end, Out out)
@@ -326,7 +327,7 @@
return std::make_pair(p, out);
}
- /** Throws std::out_of_range if [<tt>begin</tt>, <tt>end</tt>[ is not a valid UTF-8 range. */
+ /** Throws \c std::out_of_range if [<tt>begin</tt>, <tt>end</tt>[ is not a valid UTF-8 range. */
template<typename In, typename Out>
std::pair<In, Out>
rtl(In begin, In end, Out out)
@@ -380,8 +381,9 @@
}
};
-/** Model of \c BoundaryChecker that tells whether a position lies on a code
- * point boundary within a range of UTF-8 code units. */
+/** Model of \c \xmlonly<conceptname>BoundaryChecker</conceptname>\endxmlonly
+ * that tells whether a position lies on a code point boundary within
+ * a range of UTF-8 code units. */
struct u8_boundary
{
typedef char input_type;
@@ -429,8 +431,9 @@
} // namespace detail
-/** Model of \c Pipe, either behaves like \c u16_decoder or
- * \c u8_decoder depending on the value type of the input range. */
+/** Model of \c \xmlonly<conceptname>Pipe</conceptname>\endxmlonly,
+ * either behaves like \c u16_decoder or \c u8_decoder depending on the
+ * value type of the input range. */
struct utf_decoder
{
typedef char32 input_type;
@@ -491,8 +494,9 @@
}
};
-/** Model of \c BoundaryChecker, either behaves like \c u16_boundary or
- * \c u8_boundary depending on the value type of the input range. */
+/** Model of \c \xmlonly<conceptname>BoundaryChecker</conceptname>\endxmlonly,
+ * either behaves like \c u16_boundary or \c u8_boundary depending on
+ * the value type of the input range. */
struct utf_boundary
{
typedef char32 input_type;
@@ -546,8 +550,8 @@
#endif
};
-/** Model of \c OneManyPipe that converts from UTF-32 to ISO-8859-1
- * alias latin-1. */
+/** Model of \c \xmlonly<conceptname>OneManyPipe</conceptname>\endxmlonly
+ * that converts from UTF-32 to ISO-8859-1 alias latin-1. */
typedef boost::detail::unspecified< cast_pipe<char> >::type latin1_encoder;
} // namespace unicode
Modified: sandbox/SOC/2009/unicode/libs/unicode/example/Jamfile.v2
==============================================================================
--- sandbox/SOC/2009/unicode/libs/unicode/example/Jamfile.v2 (original)
+++ sandbox/SOC/2009/unicode/libs/unicode/example/Jamfile.v2 2009-08-01 12:58:17 EDT (Sat, 01 Aug 2009)
@@ -6,6 +6,8 @@
# http://www.boost.org/LICENSE_1_0.txt)
#==============================================================================
+import testing ;
+
project
: requirements
<include>../../..
@@ -17,8 +19,10 @@
<link>shared:<define>BOOST_UNICODE_DYN_LINK=1
;
-exe convert : convert.cpp ;
-exe characters : characters.cpp ;
-exe compose : compose.cpp ;
-exe search : search.cpp ;
-exe source_input : source_input.cpp ;
+test-suite unicode-examples :
+ [ run convert.cpp ]
+ [ run characters.cpp ]
+ [ run compose.cpp ]
+ [ run search.cpp ]
+ [ run source_input.cpp ]
+;
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk