summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAnas Nashif <anas.nashif@intel.com>2012-10-30 20:06:05 (GMT)
committerChanho Park <chanho61.park@samsung.com>2014-12-11 10:01:59 (GMT)
commit754f4f6b337a235a8ae1d25d86656e8ef26dd2b6 (patch)
tree460394ddfac818c515bd529bb9ca455677c41612
parent8b40c674980ca61d6ed5467acffd4c3a8905dd91 (diff)
downloadboost-754f4f6b337a235a8ae1d25d86656e8ef26dd2b6.zip
boost-754f4f6b337a235a8ae1d25d86656e8ef26dd2b6.tar.gz
boost-754f4f6b337a235a8ae1d25d86656e8ef26dd2b6.tar.bz2
fix docs
-rw-r--r--boost/accumulators/framework/accumulator_set.hpp2
-rw-r--r--boost/accumulators/framework/extractor.hpp2
-rw-r--r--boost/algorithm/string/finder.hpp8
-rw-r--r--boost/algorithm/string/formatter.hpp2
-rw-r--r--boost/date_time/dst_rules.hpp2
-rw-r--r--boost/date_time/strings_from_facet.hpp10
-rw-r--r--boost/date_time/time_zone_names.hpp2
-rw-r--r--boost/intrusive/linear_slist_algorithms.hpp2
-rw-r--r--boost/mpi/collectives.hpp8
-rw-r--r--boost/mpi/operations.hpp2
-rw-r--r--boost/program_options/value_semantic.hpp2
11 files changed, 21 insertions, 21 deletions
diff --git a/boost/accumulators/framework/accumulator_set.hpp b/boost/accumulators/framework/accumulator_set.hpp
index ed1ceb1..8d10023 100644
--- a/boost/accumulators/framework/accumulator_set.hpp
+++ b/boost/accumulators/framework/accumulator_set.hpp
@@ -234,7 +234,6 @@ struct accumulator_set
///////////////////////////////////////////////////////////////////////////////
/// Accumulation
- /// \param a1 Optional named parameter to be passed to all the accumulators
void operator ()()
{
this->visit(
@@ -244,6 +243,7 @@ struct accumulator_set
);
}
+ /// \param a1 Optional named parameter to be passed to all the accumulators
template<typename A1>
void operator ()(A1 const &a1)
{
diff --git a/boost/accumulators/framework/extractor.hpp b/boost/accumulators/framework/extractor.hpp
index 98281ce..dec36da 100644
--- a/boost/accumulators/framework/extractor.hpp
+++ b/boost/accumulators/framework/extractor.hpp
@@ -94,7 +94,6 @@ struct extractor
};
/// Extract the result associated with Feature from the accumulator set
- /// \param acc The accumulator set object from which to extract the result
template<typename Arg1>
typename detail::extractor_result<Arg1, Feature>::type
operator ()(Arg1 const &arg1) const
@@ -106,6 +105,7 @@ struct extractor
/// \overload
///
+ /// \param acc The accumulator set object from which to extract the result
/// \param a1 Optional named parameter to be passed to the accumulator's result() function.
template<typename AccumulatorSet, typename A1>
typename detail::extractor_result<AccumulatorSet, Feature>::type
diff --git a/boost/algorithm/string/finder.hpp b/boost/algorithm/string/finder.hpp
index 93f7ec3..9fc195d 100644
--- a/boost/algorithm/string/finder.hpp
+++ b/boost/algorithm/string/finder.hpp
@@ -43,7 +43,6 @@ namespace boost {
The result is given as an \c iterator_range delimiting the match.
\param Search A substring to be searched for.
- \param Comp An element comparison predicate
\return An instance of the \c first_finder object
*/
template<typename RangeT>
@@ -62,6 +61,7 @@ namespace boost {
//! "First" finder
/*!
\overload
+ \param Comp An element comparison predicate
*/
template<typename RangeT,typename PredicateT>
inline detail::first_finderF<
@@ -84,7 +84,6 @@ namespace boost {
The result is given as an \c iterator_range delimiting the match.
\param Search A substring to be searched for.
- \param Comp An element comparison predicate
\return An instance of the \c last_finder object
*/
template<typename RangeT>
@@ -102,6 +101,7 @@ namespace boost {
//! "Last" finder
/*!
\overload
+ \param Comp An element comparison predicate
*/
template<typename RangeT, typename PredicateT>
inline detail::last_finderF<
@@ -124,7 +124,6 @@ namespace boost {
\param Search A substring to be searched for.
\param Nth An index of the match to be find
- \param Comp An element comparison predicate
\return An instance of the \c nth_finder object
*/
template<typename RangeT>
@@ -144,6 +143,7 @@ namespace boost {
//! "Nth" finder
/*!
\overload
+ \param Comp An element comparison predicate
*/
template<typename RangeT, typename PredicateT>
inline detail::nth_finderF<
@@ -230,7 +230,6 @@ namespace boost {
\param Begin Beginning of the range
\param End End of the range
- \param Range The range.
\return An instance of the \c range_finger object
*/
template< typename ForwardIteratorT >
@@ -245,6 +244,7 @@ namespace boost {
//! "Range" finder
/*!
\overload
+ \param Range The range.
*/
template< typename ForwardIteratorT >
inline detail::range_finderF<ForwardIteratorT>
diff --git a/boost/algorithm/string/formatter.hpp b/boost/algorithm/string/formatter.hpp
index de8681b..e333844 100644
--- a/boost/algorithm/string/formatter.hpp
+++ b/boost/algorithm/string/formatter.hpp
@@ -76,8 +76,6 @@ 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
- resulting empty_container<>.
\return An instance of the \c empty_formatter object.
*/
template<typename RangeT>
diff --git a/boost/date_time/dst_rules.hpp b/boost/date_time/dst_rules.hpp
index 3229019..feffffb 100644
--- a/boost/date_time/dst_rules.hpp
+++ b/boost/date_time/dst_rules.hpp
@@ -94,7 +94,7 @@ namespace boost {
* @param dst_start_offset Time offset within day for dst boundary
* @param dst_end_day Ending day of dst for the given locality
* @param dst_end_offset Time offset within day given in dst for dst boundary
- * @param dst_length lenght of dst adjusment
+ * @param dst_length_minutes length of dst adjustment
* @retval The time is either ambiguous, invalid, in dst, or not in dst
*/
static time_is_dst_result
diff --git a/boost/date_time/strings_from_facet.hpp b/boost/date_time/strings_from_facet.hpp
index 800919a..7596be9 100644
--- a/boost/date_time/strings_from_facet.hpp
+++ b/boost/date_time/strings_from_facet.hpp
@@ -21,8 +21,9 @@ namespace boost { namespace date_time {
* all the month strings from a locale. This is handy when building
* custom date parsers or formatters that need to be localized.
*
- *@param charT The type of char to use when gathering typically char
- * or wchar_t.
+ *! charT The type of char to use when gathering, typically char
+ * or wchar_t.
+ *
*@param locale The locale to use when gathering the strings
*@param short_strings True(default) to gather short strings,
* false for long strings.
@@ -71,8 +72,9 @@ gather_month_strings(const std::locale& locale, bool short_strings=true)
* 'Sunday'. This is handy when building custom date parsers or
* formatters that need to be localized.
*
- *@param charT The type of char to use when gathering typically char
- * or wchar_t.
+ *! charT The type of char to use when gathering, typically char
+ * or wchar_t.
+ *
*@param locale The locale to use when gathering the strings
*@param short_strings True(default) to gather short strings,
* false for long strings.
diff --git a/boost/date_time/time_zone_names.hpp b/boost/date_time/time_zone_names.hpp
index 405e7e0..63ecfca 100644
--- a/boost/date_time/time_zone_names.hpp
+++ b/boost/date_time/time_zone_names.hpp
@@ -43,7 +43,7 @@ namespace date_time {
* name: Pacific Standard Time and the abbreviated name: PST.
* During daylight savings there are additional names:
* Pacific Daylight Time and PDT.
- *@parm CharT Allows class to support different character types
+ *@param CharT Allows the class to support different character types
*/
template<class CharT>
class time_zone_names_base
diff --git a/boost/intrusive/linear_slist_algorithms.hpp b/boost/intrusive/linear_slist_algorithms.hpp
index 31e5594..d8eb4f9 100644
--- a/boost/intrusive/linear_slist_algorithms.hpp
+++ b/boost/intrusive/linear_slist_algorithms.hpp
@@ -65,7 +65,7 @@ class linear_slist_algorithms
#if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED)
- //! <b>Effects</b>: Constructs an non-used list element, putting the next
+ //! <b>Effects</b>: Constructs n non-used list element, putting the next
//! pointer to null:
//! <tt>NodeTraits::get_next(this_node) == node_ptr()</tt>
//!
diff --git a/boost/mpi/collectives.hpp b/boost/mpi/collectives.hpp
index e74fd72..6e0cbdd 100644
--- a/boost/mpi/collectives.hpp
+++ b/boost/mpi/collectives.hpp
@@ -235,10 +235,6 @@ all_to_all(const communicator& comm, const T* in_values, int n, T* out_values);
* non-roots will reshape the objects held in their proxies based on
* the skeleton sent from the root.
*
- * @param n When supplied, the number of values that the pointer @p
- * values points to, for broadcasting an array of values. The value
- * of @p n must be the same for all processes in @p comm.
- *
* @param root The rank/process ID of the process that will be
* transmitting the value.
*/
@@ -247,6 +243,10 @@ void broadcast(const communicator& comm, T& value, int root);
/**
* \overload
+ * @param n When supplied, the number of values that the pointer @p
+ * values points to, for broadcasting an array of values. The value
+ * of @p n must be the same for all processes in @p comm.
+ *
*/
template<typename T>
void broadcast(const communicator& comm, T* values, int n, int root);
diff --git a/boost/mpi/operations.hpp b/boost/mpi/operations.hpp
index c1189e4..4949786 100644
--- a/boost/mpi/operations.hpp
+++ b/boost/mpi/operations.hpp
@@ -13,7 +13,7 @@
* This header provides a mapping from function objects to @c MPI_Op
* constants used in MPI collective operations. It also provides
* several new function object types not present in the standard @c
- * <functional> header that have direct mappings to @c MPI_Op.
+ * &lt;functional&gt; header that have direct mappings to @c MPI_Op.
*/
#ifndef BOOST_MPI_IS_MPI_OP_HPP
#define BOOST_MPI_IS_MPI_OP_HPP
diff --git a/boost/program_options/value_semantic.hpp b/boost/program_options/value_semantic.hpp
index 081e997..940a80b 100644
--- a/boost/program_options/value_semantic.hpp
+++ b/boost/program_options/value_semantic.hpp
@@ -401,7 +401,7 @@ namespace boost { namespace program_options {
typed_value<T, wchar_t>*
wvalue(T* v);
- /** Works the same way as the 'value<bool>' function, but the created
+ /** Works the same way as the 'value&lt;bool&gt;' function, but the created
value_semantic won't accept any explicit value. So, if the option
is present on the command line, the value will be 'true'.
*/