[Boost-commit] svn:boost r63020 - in trunk: boost/units libs/units/doc

Subject: [Boost-commit] svn:boost r63020 - in trunk: boost/units libs/units/doc
From: steven_at_[hidden]
Date: 2010-06-16 10:23:18

Author: steven_watanabe
Date: 2010-06-16 10:23:17 EDT (Wed, 16 Jun 2010)
New Revision: 63020
URL: http://svn.boost.org/trac/boost/changeset/63020

Log:
Clean up some doc issues.
Text files modified: 
   trunk/boost/units/config.hpp               |     4 ----                                    
   trunk/boost/units/heterogeneous_system.hpp |     2 --                                      
   trunk/boost/units/io.hpp                   |    16 ++++------------                        
   trunk/libs/units/doc/Jamfile.v2            |     5 +----                                   
   4 files changed, 5 insertions(+), 22 deletions(-)

Modified: trunk/boost/units/config.hpp
==============================================================================
--- trunk/boost/units/config.hpp	(original)
+++ trunk/boost/units/config.hpp	2010-06-16 10:23:17 EDT (Wed, 16 Jun 2010)
@@ -8,10 +8,6 @@
 // accompanying file LICENSE_1_0.txt or copy at
 // http://www.boost.org/LICENSE_1_0.txt)
 
-/// \file
-/// \brief Boost units library configuration and Doxygen mainpage.
-/// \details BOOST_UNITS_HAS_BOOST_TYPEOF, BOOST_UNITS_REQUIRE_LAYOUT_COMPATIBILITY
-
 #ifndef BOOST_UNITS_CONFIG_HPP
 #define BOOST_UNITS_CONFIG_HPP
 

Modified: trunk/boost/units/heterogeneous_system.hpp
==============================================================================
--- trunk/boost/units/heterogeneous_system.hpp	(original)
+++ trunk/boost/units/heterogeneous_system.hpp	2010-06-16 10:23:17 EDT (Wed, 16 Jun 2010)
@@ -13,8 +13,6 @@
 
 /// \file
 /// \brief A heterogeneous system is a sorted list of base unit/exponent pairs.
-/// \details As long as we don't need to convert heterogeneous systems
-///   directly everything is cool.
 
 #include <boost/mpl/bool.hpp>
 #include <boost/mpl/plus.hpp>

Modified: trunk/boost/units/io.hpp
==============================================================================
--- trunk/boost/units/io.hpp	(original)
+++ trunk/boost/units/io.hpp	2010-06-16 10:23:17 EDT (Wed, 16 Jun 2010)
@@ -15,7 +15,7 @@
 /// \brief Stream input and output for rationals, units and quantities.
 /// \details Functions and manipulators for output and input of units and quantities.
 ///   symbol and name format, and engineering and binary autoprefix.
-///   Serialisation output is also supported.
+///   Serialization output is also supported.
 
 #include <cassert>
 #include <cmath>
@@ -157,14 +157,13 @@
 
 } // namespace detail
 
-/// \return flags controlling output.
+/// returns flags controlling output.
 inline long get_flags(std::ios_base& ios, long mask) 
 {
     return(ios.iword(detail::xalloc_key_holder<true>::value) & mask);
 }
 
 /// Set new flags controlling output format.
-/// \return previous flags.
 inline void set_flags(std::ios_base& ios, long new_flags, long mask) 
 {
     assert((~mask & new_flags) == 0);
@@ -172,7 +171,7 @@
     flags = (flags & ~mask) | new_flags;
 }
 
-/// \return flags controlling output format.
+/// returns flags controlling output format.
 inline format_mode get_format(std::ios_base& ios) 
 {
     return(static_cast<format_mode>((get_flags)(ios, fmt_mask)));
@@ -185,7 +184,6 @@
 }
 
 /// Set new flags for type_name output format.
-/// \return previous format flags.
 inline std::ios_base& typename_format(std::ios_base& ios) 
 {
     (set_format)(ios, typename_fmt);
@@ -193,15 +191,13 @@
 }
 
 /// set new flag for raw format output, for example "m".
-/// \return previous format flags.
 inline std::ios_base& raw_format(std::ios_base& ios) 
 {
     (set_format)(ios, raw_fmt);
     return(ios);
 }
 
-// set new format flag for symbol output, for example "m".
-/// \return previous format flags.
+/// set new format flag for symbol output, for example "m".
 inline std::ios_base& symbol_format(std::ios_base& ios) 
 {
     (set_format)(ios, symbol_fmt);
@@ -209,7 +205,6 @@
 }
 
 /// set new format for name output, for example "meter".
-/// \return previous format flags.
 inline std::ios_base& name_format(std::ios_base& ios) 
 {
     (set_format)(ios, name_fmt);
@@ -229,7 +224,6 @@
 }
 
 /// Clear autoprefix flags.
-/// \return previous prefix flags.
 inline std::ios_base& no_prefix(std::ios_base& ios)
 {
     (set_autoprefix)(ios, autoprefix_none);
@@ -237,7 +231,6 @@
 }
 
 /// Set flag for engineering prefix, so 1234.5 m displays as "1.2345 km".
-/// \return previous prefix flags.
 inline std::ios_base& engineering_prefix(std::ios_base& ios)
 {
     (set_autoprefix)(ios, autoprefix_engineering);
@@ -245,7 +238,6 @@
 }
 
 /// Set flag for binary prefix, so 1024 byte displays as "1 Kib".
-/// \return previous prefix flags.
 inline std::ios_base& binary_prefix(std::ios_base& ios)
 {
     (set_autoprefix)(ios, autoprefix_binary);

Modified: trunk/libs/units/doc/Jamfile.v2
==============================================================================
--- trunk/libs/units/doc/Jamfile.v2	(original)
+++ trunk/libs/units/doc/Jamfile.v2	2010-06-16 10:23:17 EDT (Wed, 16 Jun 2010)
@@ -168,10 +168,7 @@
             local dir-name = [ path.basename [ path.parent $(file) ] ] ;
             base_unit = "$(base_unit) ($(dir-name))" ;
         }
-        # this looks better, but it won't work until my boostbook patch for
-        # annotation.xsl gets applied.
-        # print.text "[headerref $(output_filename) $(base_unit)]\\n" : overwrite ;
-        print.text "[headerref $(output_filename)]\\n" : overwrite ;
+        print.text "[headerref $(output_filename) $(base_unit)]\\n" : overwrite ;
     }
 }