[Boost-commit] svn:boost r39910 - in sandbox/units: boost/units/systems/other libs/units/doc

From: steven_at_[hidden]
Date: 2007-10-10 17:47:16

Author: steven_watanabe
Date: 2007-10-10 17:47:16 EDT (Wed, 10 Oct 2007)
New Revision: 39910
URL: http://svn.boost.org/trac/boost/changeset/39910

Log:
Split the reference for the systems up.  Putting all the files in a single group is too unwieldy not to mention that boostbook puts them in a strange order.  Also made the documentation for other/non_si_units.hpp fit for human consumption
Text files modified: 
   sandbox/units/boost/units/systems/other/non_si_units.hpp |    14 ++++++-                                 
   sandbox/units/libs/units/doc/Jamfile.v2                  |    69 ++++++++++++++++++++++++++++++++++++--- 
   sandbox/units/libs/units/doc/units.qbk                   |     8 ++++                                    
   3 files changed, 82 insertions(+), 9 deletions(-)

Modified: sandbox/units/boost/units/systems/other/non_si_units.hpp
==============================================================================
--- sandbox/units/boost/units/systems/other/non_si_units.hpp	(original)
+++ sandbox/units/boost/units/systems/other/non_si_units.hpp	2007-10-10 17:47:16 EDT (Wed, 10 Oct 2007)
@@ -24,6 +24,14 @@
 #include <boost/units/systems/si/volume.hpp>
 #include <boost/units/systems/si/force.hpp>
 
+#ifdef BOOST_UNITS_DOXYGEN
+///INTERNAL ONLY
+#define BOOST_UNITS_DEFINE_CONVERSION(name, unit, type, factor)
+///INTERNAL ONLY
+#define BOOST_UNITS_DEFAULT_CONVERSION(name, unit)
+#endif
+
+///INTERNAL ONLY
 #define BOOST_UNITS_NON_SI_UNIT(name, factor, unit, id)                     \
 namespace boost {                                                           \
 namespace units {                                                           \
@@ -35,6 +43,7 @@
 BOOST_UNITS_DEFINE_CONVERSION(BOOST_UNITS_NAMESPACE::name, unit, double, factor); \
 BOOST_UNITS_DEFAULT_CONVERSION(BOOST_UNITS_NAMESPACE::name, unit)
 
+///INTERNAL ONLY
 #define BOOST_UNITS_NAMESPACE astronomical
 
 BOOST_UNITS_NON_SI_UNIT(astronomical_unit_base_unit, 149597870691.0, meter_base_unit::unit_type, 0);
@@ -205,6 +214,7 @@
 #undef BOOST_UNITS_NAMESPACE
 #undef BOOST_UNITS_END_NAMESPACE
 
+/*
 namespace boost {
 
 namespace units { 
@@ -213,7 +223,6 @@
                             
 namespace constants {
 
-/*
 namespace english {
 
 /// barleycorn
@@ -308,7 +317,7 @@
 BOOST_UNITS_AUTO_STATIC_CONSTANT(cloth_span,0.2286*meters);
 /// stick
 BOOST_UNITS_AUTO_STATIC_CONSTANT(stick,50.8e-3*meters);
-*/
+
 } // constants                                                                                  
 
 } // namespace SI
@@ -316,5 +325,6 @@
 } // namespace units
 
 } // namespace boost
+*/
 
 #endif // BOOST_UNITS_NON_SI_CONSTANTS_HPP

Modified: sandbox/units/libs/units/doc/Jamfile.v2
==============================================================================
--- sandbox/units/libs/units/doc/Jamfile.v2	(original)
+++ sandbox/units/libs/units/doc/Jamfile.v2	2007-10-10 17:47:16 EDT (Wed, 10 Oct 2007)
@@ -13,9 +13,11 @@
 
 using doxygen ;
 
-rule run_doxygen ( target : files * : name )
+rule run_doxygen ( target : files * : name : expand ? )
 {
 
+    expand ?= <doxygen:param>EXPAND_ONLY_PREDEF=YES ;
+
 doxygen $(target)
   :
     $(files)
@@ -31,7 +33,7 @@
         <doxygen:param>EXTRACT_PRIVATE=NO
         <doxygen:param>ENABLE_PREPROCESSING=YES
         <doxygen:param>MACRO_EXPANSION=YES
-        <doxygen:param>EXPAND_ONLY_PREDEF=YES
+        $(expand)
         <doxygen:param>SEARCH_INCLUDES=NO
         <reftitle>$(name)
   ;
@@ -46,11 +48,61 @@
     "Units Reference"
   ;
 
-run_doxygen systems_reference
+run_doxygen si_reference
+  :
+    ../../../boost/units/systems/si.hpp
+    [ path.glob-tree ../../../boost/units/systems/si : *.hpp : detail ]
+  :
+    "SI System Reference"
+  ;
+
+run_doxygen cgs_reference
+  :
+    ../../../boost/units/systems/cgs.hpp
+    [ path.glob-tree ../../../boost/units/systems/cgs : *.hpp : detail ]
+  :
+    "CGS System Reference"
+  ;
+
+run_doxygen base_units_reference
+  :
+    ../../../boost/units/systems/base_units.hpp
+    ../../../boost/units/systems/other/non_si_units.hpp
+    [ path.glob-tree ../../../boost/units/systems/base_units : *.hpp : detail ]
+  :
+    "Base Units Reference"
+  :
+    <doxygen:param>EXPAND_ONLY_PREDEF=NO
+  ;
+
+run_doxygen dimensions_reference
+  :
+    ../../../boost/units/systems/physical_units.hpp
+    [ path.glob-tree ../../../boost/units/systems/physical_dimensions : *.hpp : detail ]
+  :
+    "Dimensions Reference"
+  ;
+
+run_doxygen trig_reference
+  :
+    ../../../boost/units/systems/trig.hpp
+    [ path.glob-tree ../../../boost/units/systems/angle : *.hpp : detail ]
+  :
+    "Trigonometry and Angle System Reference"
+  ;
+
+run_doxygen temperature_reference
+  :
+    [ path.glob-tree ../../../boost/units/systems/temperature : *.hpp : detail ]
+  :
+    "Temperature System Reference"
+  ;
+
+run_doxygen abstart_reference
   :
-    [ path.glob-tree ../../../boost/units/systems : *.hpp : detail ]
+    ../../../boost/units/systems/abstract.hpp
   :
-    "Systems Reference"
+    "Abstract System Reference"
   ;
 
 xml units
@@ -64,7 +116,12 @@
     units
   :
     <dependency>units_reference
-    <dependency>systems_reference
+    <dependency>si_reference
+    <dependency>cgs_reference
+    <dependency>base_units_reference
+    <dependency>dimensions_reference
+    <dependency>trig_reference
+    <dependency>temperature_reference
     <xsl:param>toc.max.depth=1
     <xsl:param>toc.section.depth=8
     <xsl:param>chunk.section.depth=8

Modified: sandbox/units/libs/units/doc/units.qbk
==============================================================================
--- sandbox/units/libs/units/doc/units.qbk	(original)
+++ sandbox/units/libs/units/doc/units.qbk	2007-10-10 17:47:16 EDT (Wed, 10 Oct 2007)
@@ -1027,7 +1027,13 @@
 
 [xinclude units_reference.xml]
 
-[xinclude systems_reference.xml]
+[xinclude si_reference.xml]
+[xinclude cgs_reference.xml]
+[xinclude base_units_reference.xml]
+[xinclude dimensions_reference.xml]
+[xinclude trig_reference.xml]
+[xinclude temperature_reference.xml]
+[xinclude abstract_reference.xml]
 
 [endsect]