1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
|
# Units documentation Jamfile
#
# Copyright (c) 2007-2008
# Steven Watanabe
#
# Distributed under the Boost Software License, Version 1.0. (See
# accompanying file LICENSE_1_0.txt or copy at
# http://www.boost.org/LICENSE_1_0.txt
import path ;
import quickbook ;
using boostbook ;
using doxygen ;
import print ;
import regex ;
import sequence ;
path-constant here : . ;
rule run_doxygen ( target : files * : name )
{
doxygen $(target)
:
$(files)
:
<doxygen:param>EXTRACT_ALL=YES
<doxygen:param>EXPAND_ONLY_PREDEF=YES
# Horribly ugly, but then macros usually are :(
<doxygen:param>"PREDEFINED= \\
\"BOOST_MPL_ASSERT(expr)=\" \\
\"BOOST_UNITS_STATIC_CONSTANT(a,b)=static const b a\" \\
\"BOOST_UNITS_AUTO_STATIC_CONSTANT(a,b)=static const auto a = b\" \\
\"BOOST_UNITS_TYPEOF(a)=typeof(a)\" \\
\"BOOST_PREVENT_MACRO_SUBSTITUTION=\" \\
\"BOOST_UNITS_HAS_TYPEOF=1\" \\
\"BOOST_UNITS_DEFINE_BASE_UNIT_WITH_CONVERSIONS(namespace_, name_, name_string, symbol_, factor, other_unit, id)= \\
namespace boost { namespace units { namespace namespace_ { \\
struct name_ ## _base_unit : boost::units::base_unit<name_ ## _base_unit, other_unit::dimension_type, id> { \\
static const char* name(); \\
static const char* symbol(); \\
}; \\
} } }\" \\
\"BOOST_UNITS_DOXYGEN=1\""
<doxygen:param>HIDE_UNDOC_MEMBERS=NO
<doxygen:param>EXTRACT_PRIVATE=NO
<doxygen:param>ENABLE_PREPROCESSING=YES
<doxygen:param>MACRO_EXPANSION=YES
$(expand)
<doxygen:param>SEARCH_INCLUDES=NO
<reftitle>$(name)
;
}
run_doxygen units_reference
:
[ glob $(here)/../../../boost/units/*.hpp :
$(here)/../../../boost/units/physical_dimensions.hpp ]
:
"Units Reference"
;
run_doxygen si_reference
:
$(here)/../../../boost/units/systems/si.hpp
[ path.glob-tree $(here)/../../../boost/units/systems/si : *.hpp : detail ]
:
"SI System Reference"
;
run_doxygen cgs_reference
:
$(here)/../../../boost/units/systems/cgs.hpp
[ path.glob-tree $(here)/../../../boost/units/systems/cgs : *.hpp : detail ]
:
"CGS System Reference"
;
rule make_base_units_doc ( directory : name )
{
run_doxygen $(directory)_base_units_reference
:
[ path.glob-tree $(here)/../../../boost/units/base_units/$(directory) : *.hpp : detail conversions.hpp ]
:
"$(name) Base Units Reference"
;
}
make_base_units_doc angle : Angle ;
make_base_units_doc astronomical : Astronomical ;
make_base_units_doc cgs : CGS ;
make_base_units_doc imperial : Imperial ;
make_base_units_doc information : Information ;
make_base_units_doc metric : Metric ;
make_base_units_doc si : SI ;
make_base_units_doc temperature : Temperature ;
make_base_units_doc us : US ;
all_base_units_doc = angle astronomical cgs imperial information metric si temperature us ;
all_base_units_doc = $(all_base_units_doc)_base_units_reference ;
run_doxygen dimensions_reference
:
$(here)/../../../boost/units/physical_dimensions.hpp
[ path.glob-tree $(here)/../../../boost/units/physical_dimensions : *.hpp : detail ]
:
"Dimensions Reference"
;
run_doxygen trig_reference
:
#../../../boost/units/systems/trig.hpp
[ path.glob-tree $(here)/../../../boost/units/systems/angle : *.hpp : detail ]
:
"Trigonometry and Angle System Reference"
;
run_doxygen temperature_reference
:
[ path.glob-tree $(here)/../../../boost/units/systems/temperature : *.hpp : detail ]
:
"Temperature System Reference"
;
run_doxygen information_reference
:
$(here)/../../../boost/units/systems/information.hpp
[ path.glob-tree $(here)/../../../boost/units/systems/information : *.hpp : detail prefixes.hpp ]
:
"Information System Reference"
;
run_doxygen abstract_reference
:
$(here)/../../../boost/units/systems/abstract.hpp
:
"Abstract System Reference"
;
rule less ( a b )
{
if [ path.basename $(a) ] < [ path.basename $(b) ]
{
return true ;
}
}
rule generate-qbk ( target : sources * : properties * )
{
print.output $(target) ;
local as-path = [ sequence.transform path.make : $(sources:G=) ] ;
local known = ;
local duplicated = ;
for local file in $(as-path)
{
local base = [ path.basename $(file) ] ;
if $(base) in $(known)
{
if ! $(base) in $(duplicated)
{
duplicated += $(base) ;
}
} else
{
known += $(base) ;
}
}
for local file in [ sequence.insertion-sort $(as-path) : less ]
{
local output_filename = [ path.relative-to [ path.make $(here)/../../.. ] $(file) ] ;
local base_filename = [ path.basename $(file) ] ;
local base_unit = [ regex.replace $(base_filename) "\\.hpp" "" ] ;
if $(base_filename) in $(duplicated)
{
# tack the directory name onto the end
local dir-name = [ path.basename [ path.parent $(file) ] ] ;
base_unit = "$(base_unit) ($(dir-name))" ;
}
print.text "[headerref $(output_filename) $(base_unit)][br]" : overwrite ;
}
}
make base_units.qbk : [ path.glob-tree $(here)/../../../boost/units/base_units : *.hpp : detail conversions.hpp ] : @generate-qbk ;
explicit base_units ;
install base_units_install : base_units.qbk : <location>. ;
xml units
:
units.qbk
:
<dependency>base_units_install
<dependency>units_reference
<dependency>si_reference
<dependency>cgs_reference
<dependency>$(all_base_units_doc)
<dependency>dimensions_reference
<dependency>trig_reference
<dependency>temperature_reference
<dependency>information_reference
<dependency>abstract_reference
;
boostbook standalone
:
units
:
<xsl:param>toc.max.depth=1
<xsl:param>toc.section.depth=8
<xsl:param>chunk.section.depth=8
<xsl:param>boost.root="../../../.."
<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
;
|