From b2a16f4bb05504e0bc6ad3258d48ec7604c7b873 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Tue, 30 Oct 2012 13:06:05 -0700 Subject: fix docs --- boost/accumulators/framework/accumulator_set.hpp | 2 +- boost/accumulators/framework/extractor.hpp | 2 +- boost/algorithm/string/finder.hpp | 8 ++++---- boost/algorithm/string/formatter.hpp | 2 -- boost/date_time/dst_rules.hpp | 2 +- boost/date_time/strings_from_facet.hpp | 10 ++++++---- boost/date_time/time_zone_names.hpp | 2 +- boost/intrusive/linear_slist_algorithms.hpp | 4 ++-- boost/mpi/collectives.hpp | 8 ++++---- boost/mpi/operations.hpp | 2 +- boost/program_options/value_semantic.hpp | 2 +- libs/mpi/doc/mpi.qbk | 2 +- 12 files changed, 23 insertions(+), 23 deletions(-) diff --git a/boost/accumulators/framework/accumulator_set.hpp b/boost/accumulators/framework/accumulator_set.hpp index ed1ceb1afa..8d10023ffb 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 void operator ()(A1 const &a1) { diff --git a/boost/accumulators/framework/extractor.hpp b/boost/accumulators/framework/extractor.hpp index 98281cecb9..dec36dad07 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 detail::extractor_result::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 detail::extractor_result::type diff --git a/boost/algorithm/string/finder.hpp b/boost/algorithm/string/finder.hpp index 4c7ac38b04..60259dd6ee 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 @@ -62,6 +61,7 @@ namespace boost { //! "First" finder /*! \overload + \param Comp An element comparison predicate */ template 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 @@ -102,6 +101,7 @@ namespace boost { //! "Last" finder /*! \overload + \param Comp An element comparison predicate */ template 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 @@ -144,6 +143,7 @@ namespace boost { //! "Nth" finder /*! \overload + \param Comp An element comparison predicate */ template 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 diff --git a/boost/algorithm/string/formatter.hpp b/boost/algorithm/string/formatter.hpp index ab5921e730..10386c09c2 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 diff --git a/boost/date_time/dst_rules.hpp b/boost/date_time/dst_rules.hpp index 20cb40b676..45cff649b8 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 d782c54fb9..f85fa150d1 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 05260c7162..41a5720aa1 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 time_zone_names_base diff --git a/boost/intrusive/linear_slist_algorithms.hpp b/boost/intrusive/linear_slist_algorithms.hpp index f33565528e..33d58cb2a4 100644 --- a/boost/intrusive/linear_slist_algorithms.hpp +++ b/boost/intrusive/linear_slist_algorithms.hpp @@ -60,9 +60,9 @@ class linear_slist_algorithms #if defined(BOOST_INTRUSIVE_DOXYGEN_INVOKED) - //! Effects: Constructs an non-used list element, putting the next + //! Effects: Constructs n non-used list element, putting the next //! pointer to null: - //! NodeTraits::get_next(this_node) == node_ptr() + //! NodeTraits::get_next(this_node) == 0 //! //! Complexity: Constant //! diff --git a/boost/mpi/collectives.hpp b/boost/mpi/collectives.hpp index 76d6bda3ae..73d70d60df 100644 --- a/boost/mpi/collectives.hpp +++ b/boost/mpi/collectives.hpp @@ -219,10 +219,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. */ @@ -231,6 +227,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 void broadcast(const communicator& comm, T* values, int n, int root); diff --git a/boost/mpi/operations.hpp b/boost/mpi/operations.hpp index c1189e4364..4949786c0e 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 - * header that have direct mappings to @c MPI_Op. + * <functional> 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 033009e095..9084e4697e 100644 --- a/boost/program_options/value_semantic.hpp +++ b/boost/program_options/value_semantic.hpp @@ -385,7 +385,7 @@ namespace boost { namespace program_options { typed_value* wvalue(T* v); - /** Works the same way as the 'value' function, but the created + /** Works the same way as the 'value<bool>' 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'. */ diff --git a/libs/mpi/doc/mpi.qbk b/libs/mpi/doc/mpi.qbk index 451426b3bf..050cf13d63 100644 --- a/libs/mpi/doc/mpi.qbk +++ b/libs/mpi/doc/mpi.qbk @@ -1846,7 +1846,7 @@ routine, e.g., `skeleton_proxy` objects can be received on the other end via `recv()`, which stores a newly-created instance of your data structure with the -same "shape" as the sender in its `"object` attribute: +same "shape" as the sender in its `object` attribute: shape = mpi.world.recv(0, 0) my_data_structure = shape.object -- cgit v1.2.3