File boost-fix_documentation.patch of Package boost

Overview Repositories Revisions Requests Users Attributes Meta

File boost-fix_documentation.patch of Package boost (Revision 0b82d7677db40573479f0fc6e4902a69)

Currently displaying revision 0b82d7677db40573479f0fc6e4902a69 , Show latest

Index: boost/accumulators/framework/accumulator_set.hpp
===================================================================
--- boost/accumulators/framework/accumulator_set.hpp.orig	2009-07-22 19:02:50.000000000 +0200
+++ boost/accumulators/framework/accumulator_set.hpp	2010-04-08 17:34:47.655511321 +0200
@@ -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)
 {
Index: boost/accumulators/framework/extractor.hpp
===================================================================
--- boost/accumulators/framework/extractor.hpp.orig	2008-06-20 05:47:42.000000000 +0200
+++ boost/accumulators/framework/extractor.hpp	2010-04-08 18:58:03.343500575 +0200
@@ -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
Index: boost/algorithm/string/finder.hpp
===================================================================
--- boost/algorithm/string/finder.hpp.orig	2009-09-13 21:10:55.000000000 +0200
+++ boost/algorithm/string/finder.hpp	2010-04-08 17:39:51.851512438 +0200
@@ -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>
Index: boost/algorithm/string/formatter.hpp
===================================================================
--- boost/algorithm/string/formatter.hpp.orig	2009-09-13 21:10:55.000000000 +0200
+++ boost/algorithm/string/formatter.hpp	2010-04-08 17:42:53.295011064 +0200
@@ -76,8 +76,6 @@ namespace boost {
 Construct the \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>
Index: boost/date_time/dst_rules.hpp
===================================================================
--- boost/date_time/dst_rules.hpp.orig	2008-02-27 21:00:24.000000000 +0100
+++ boost/date_time/dst_rules.hpp	2010-04-08 18:02:23.327435043 +0200
@@ -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 
Index: boost/date_time/strings_from_facet.hpp
===================================================================
--- boost/date_time/strings_from_facet.hpp.orig	2009-02-01 12:29:43.000000000 +0100
+++ boost/date_time/strings_from_facet.hpp	2010-04-08 18:06:53.639511496 +0200
@@ -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&
 * '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.
Index: boost/date_time/time_zone_names.hpp
===================================================================
--- boost/date_time/time_zone_names.hpp.orig	2008-02-27 21:00:24.000000000 +0100
+++ boost/date_time/time_zone_names.hpp	2010-04-08 18:03:52.115011588 +0200
@@ -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
Index: boost/intrusive/circular_slist_algorithms.hpp
===================================================================
--- boost/intrusive/circular_slist_algorithms.hpp.orig	2009-10-15 20:46:26.000000000 +0200
+++ boost/intrusive/circular_slist_algorithms.hpp	2010-04-08 18:09:14.535002037 +0200
@@ -63,7 +63,7 @@ class circular_slist_algorithms
 
 //! Effects: Constructs an non-used list element, putting the next
 //! pointer to null:
- //! <tt>NodeTraits::get_next(this_node) == 0
+ //! <tt>NodeTraits::get_next(this_node) == 0</tt>
 //! 
 //! Complexity: Constant 
 //! 
Index: boost/intrusive/linear_slist_algorithms.hpp
===================================================================
--- boost/intrusive/linear_slist_algorithms.hpp.orig	2009-10-15 20:46:26.000000000 +0200
+++ boost/intrusive/linear_slist_algorithms.hpp	2010-04-08 18:09:42.795795376 +0200
@@ -62,7 +62,7 @@ class linear_slist_algorithms
 
 //! Effects: Constructs an non-used list element, putting the next
 //! pointer to null:
- //! <tt>NodeTraits::get_next(this_node) == 0
+ //! <tt>NodeTraits::get_next(this_node) == 0</tt>
 //! 
 //! Complexity: Constant 
 //! 
Index: boost/mpi/collectives.hpp
===================================================================
--- boost/mpi/collectives.hpp.orig	2007-11-25 19:07:19.000000000 +0100
+++ boost/mpi/collectives.hpp	2010-04-08 17:44:55.323300553 +0200
@@ -219,10 +219,6 @@ all_to_all(const communicator& comm, con
 * 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,
 
 /**
 * \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);
Index: boost/mpi/operations.hpp
===================================================================
--- boost/mpi/operations.hpp.orig	2007-11-25 19:07:19.000000000 +0100
+++ boost/mpi/operations.hpp	2010-04-08 17:45:43.579010784 +0200
@@ -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
Index: boost/program_options/value_semantic.hpp
===================================================================
--- boost/program_options/value_semantic.hpp.orig	2010-01-08 22:00:57.000000000 +0100
+++ boost/program_options/value_semantic.hpp	2010-04-08 17:32:01.139005255 +0200
@@ -385,7 +385,7 @@ namespace boost { namespace program_opti
 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'.
 */
Index: boost/units/cmath.hpp
===================================================================
--- boost/units/cmath.hpp.orig	2009-07-28 21:05:27.000000000 +0200
+++ boost/units/cmath.hpp	2010-04-08 17:59:56.771242946 +0200
@@ -30,7 +30,7 @@
 /// \file 
 /// \brief Overloads of functions in \<cmath\> for quantities
 ///
-/// \detailed Only functions for which a dimensionally-correct result type 
+/// \detail Only functions for which a dimensionally-correct result type 
 /// can be determined are overloaded. All functions work with dimensionless
 /// quantities.
 
Index: boost/units/dim.hpp
===================================================================
--- boost/units/dim.hpp.orig	2008-06-20 06:37:32.000000000 +0200
+++ boost/units/dim.hpp	2010-04-08 17:59:12.003511062 +0200
@@ -36,7 +36,7 @@ struct dim_tag { };
 
 /// \brief Dimension tag/exponent pair for a single fundamental dimension.
 ///
-/// \detailed 
+/// \detail
 /// The dim class represents a single dimension tag/dimension exponent pair.
 /// That is, @c dim<tag_type,value_type> is a pair where @c tag_type represents the
 /// fundamental dimension being represented and @c value_type represents the 
Index: boost/units/operators.hpp
===================================================================
--- boost/units/operators.hpp.orig	2009-01-09 18:31:30.000000000 +0100
+++ boost/units/operators.hpp	2010-04-08 18:00:09.503745620 +0200
@@ -19,7 +19,7 @@
 /// \file 
 /// \brief Compile time operators and typeof helper classes.
 ///
-/// \detailed 
+/// \detail
 /// These operators declare the compile-time operators needed to support dimensional
 /// analysis algebra. They require the use of Boost.Typeof.
 /// Typeof helper classes define result type for heterogeneous operators on value types. 
Index: libs/mpi/doc/mpi.qbk
===================================================================
--- libs/mpi/doc/mpi.qbk.orig	2009-08-06 21:04:54.000000000 +0200
+++ libs/mpi/doc/mpi.qbk	2010-04-08 18:14:30.531010979 +0200
@@ -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

Places

File boost-fix_documentation.patch of Package boost (Revision 0b82d7677db40573479f0fc6e4902a69)

Places