|
|
Boost-Commit : |
From: steven_at_[hidden]
Date: 2007-08-27 16:49:41
Author: steven_watanabe
Date: 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
New Revision: 39018
URL: http://svn.boost.org/trac/boost/changeset/39018
Log:
Tweak doxygen comments
Text files modified:
sandbox/units/boost/units/absolute.hpp | 2 ++
sandbox/units/boost/units/base_dimension.hpp | 2 ++
sandbox/units/boost/units/base_unit.hpp | 4 +++-
sandbox/units/boost/units/conversion.hpp | 4 ++++
sandbox/units/boost/units/get_dimension.hpp | 3 +++
sandbox/units/boost/units/get_system.hpp | 3 +++
sandbox/units/boost/units/homogeneous_system.hpp | 2 ++
sandbox/units/boost/units/operators.hpp | 1 +
sandbox/units/boost/units/quantity.hpp | 21 +++++++++++++++++++++
sandbox/units/boost/units/scaled_base_unit.hpp | 29 +++++++++++++++++++++++++++++
sandbox/units/boost/units/unit.hpp | 14 ++++++++++++++
11 files changed, 84 insertions(+), 1 deletions(-)
Modified: sandbox/units/boost/units/absolute.hpp
==============================================================================
--- sandbox/units/boost/units/absolute.hpp (original)
+++ sandbox/units/boost/units/absolute.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -113,6 +113,7 @@
}
+/// INTERNAL ONLY
template<class Unit1, class T1, class Unit2, class T2>
struct conversion_helper<quantity<absolute<Unit1>, T1>, quantity<absolute<Unit2>, T2> >
{
@@ -187,6 +188,7 @@
return Y(aval1.value()-aval2.value());
}
+/// INTERNAL ONLY
template<class D, class S>
struct reduce_unit<absolute<unit<D, S> > >
{
Modified: sandbox/units/boost/units/base_dimension.hpp
==============================================================================
--- sandbox/units/boost/units/base_dimension.hpp (original)
+++ sandbox/units/boost/units/base_dimension.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -43,7 +43,9 @@
/// Defines a base dimension. To define a dimension you need to provide
/// the derived class (CRTP) and a unique integer.
+/// @code
/// struct my_dimension : boost::units::base_dimension<my_dimension, 1> {};
+/// @endcode
/// It is designed so that you will get an error message if you try
/// to use the same value in multiple definitions.
template<class Derived,
Modified: sandbox/units/boost/units/base_unit.hpp
==============================================================================
--- sandbox/units/boost/units/base_unit.hpp (original)
+++ sandbox/units/boost/units/base_unit.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -45,7 +45,9 @@
/// Defines a base dimension. To define a unit you need to provide
/// the derived class (CRTP), a dimension list and a unique integer.
-/// struct my_unit : boost::units::base_unit<my_dimension, length_dimension, 1> {};
+/// @code
+/// struct my_unit : boost::units::base_unit<my_unit, length_dimension, 1> {};
+/// @endcode
/// It is designed so that you will get an error message if you try
/// to use the same value in multiple definitions.
template<class Derived,
Modified: sandbox/units/boost/units/conversion.hpp
==============================================================================
--- sandbox/units/boost/units/conversion.hpp (original)
+++ sandbox/units/boost/units/conversion.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -516,6 +516,7 @@
} // namespace detail
/// conversions between homogeneous systems are defined
+/// INTERNAL ONLY
template<class D, class L1, class T1, class L2, class T2>
struct conversion_helper<quantity<unit<D, homogeneous_system<L1> >, T1>, quantity<unit<D, homogeneous_system<L2> >, T2> >
{
@@ -537,6 +538,7 @@
};
/// conversions between heterogeneous systems and homogeneous systems are defined
+/// INTERNAL ONLY
template<class D, class L1, class T1, class L2, class T2>
struct conversion_helper<quantity<unit<D, heterogeneous_system<L1> >, T1>, quantity<unit<D, homogeneous_system<L2> >, T2> >
{
@@ -557,6 +559,7 @@
// other than just defining it as the reverse of the
// heterogeneous->homogeneous case
/// conversions between heterogeneous systems and homogeneous systems are defined
+/// INTERNAL ONLY
template<class D, class L1, class T1, class L2, class T2>
struct conversion_helper<quantity<unit<D, homogeneous_system<L1> >, T1>, quantity<unit<D, heterogeneous_system<L2> >, T2> >
{
@@ -575,6 +578,7 @@
/// Requires that all possible conversions
/// between base units are defined.
+/// INTERNAL ONLY
template<class D, class S1, class T1, class S2, class T2>
struct conversion_helper<quantity<unit<D, heterogeneous_system<S1> >, T1>, quantity<unit<D, heterogeneous_system<S2> >, T2> >
{
Modified: sandbox/units/boost/units/get_dimension.hpp
==============================================================================
--- sandbox/units/boost/units/get_dimension.hpp (original)
+++ sandbox/units/boost/units/get_dimension.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -17,6 +17,9 @@
namespace units {
+template<class T>
+struct get_dimension {};
+
/// get the dimension of a unit
template<class Dim,class System>
struct get_dimension< unit<Dim,System> >
Modified: sandbox/units/boost/units/get_system.hpp
==============================================================================
--- sandbox/units/boost/units/get_system.hpp (original)
+++ sandbox/units/boost/units/get_system.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -17,6 +17,9 @@
namespace units {
+template<class T>
+struct get_system {};
+
/// get the system of a unit
template<class Dim,class System>
struct get_system< unit<Dim,System> >
Modified: sandbox/units/boost/units/homogeneous_system.hpp
==============================================================================
--- sandbox/units/boost/units/homogeneous_system.hpp (original)
+++ sandbox/units/boost/units/homogeneous_system.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -40,12 +40,14 @@
template<class T, class R>
struct static_root;
+/// INTERNAL ONLY
template<class L, long N, long D>
struct static_power<homogeneous_system<L>, static_rational<N,D> >
{
typedef homogeneous_system<L> type;
};
+/// INTERNAL ONLY
template<class L, long N, long D>
struct static_root<homogeneous_system<L>, static_rational<N,D> >
{
Modified: sandbox/units/boost/units/operators.hpp
==============================================================================
--- sandbox/units/boost/units/operators.hpp (original)
+++ sandbox/units/boost/units/operators.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -34,6 +34,7 @@
// to avoid need for default constructor and eliminate divide by zero errors
namespace typeof_ {
+/// INTERNAL ONLY
template<class T> T make();
} // namespace typeof_
Modified: sandbox/units/boost/units/quantity.hpp
==============================================================================
--- sandbox/units/boost/units/quantity.hpp (original)
+++ sandbox/units/boost/units/quantity.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -497,6 +497,7 @@
}
/// specialize unary plus typeof helper
+/// INTERNAL ONLY
template<class Unit,class Y>
struct unary_plus_typeof_helper< quantity<Unit,Y> >
{
@@ -506,6 +507,7 @@
};
/// specialize unary minus typeof helper
+/// INTERNAL ONLY
template<class Unit,class Y>
struct unary_minus_typeof_helper< quantity<Unit,Y> >
{
@@ -515,6 +517,7 @@
};
/// specialize add typeof helper
+/// INTERNAL ONLY
template<class Unit1,
class Unit2,
class X,
@@ -527,6 +530,7 @@
};
/// specialize subtract typeof helper
+/// INTERNAL ONLY
template<class Unit1,
class Unit2,
class X,
@@ -539,6 +543,7 @@
};
/// scalar times unit typeof helper
+/// INTERNAL ONLY
template<class System,
class Dim,
class X>
@@ -550,6 +555,7 @@
};
/// unit times scalar typeof helper
+/// INTERNAL ONLY
template<class System,
class Dim,
class X>
@@ -561,6 +567,7 @@
};
/// scalar times quantity typeof helper
+/// INTERNAL ONLY
template<class Unit,
class X,
class Y>
@@ -572,6 +579,7 @@
};
/// quantity times scalar typeof helper
+/// INTERNAL ONLY
template<class Unit,
class X,
class Y>
@@ -583,6 +591,7 @@
};
/// unit times quantity typeof helper
+/// INTERNAL ONLY
template<class Unit,
class System,
class Dim,
@@ -595,6 +604,7 @@
};
/// quantity times unit typeof helper
+/// INTERNAL ONLY
template<class Unit,
class System,
class Dim,
@@ -607,6 +617,7 @@
};
/// quantity times quantity typeof helper
+/// INTERNAL ONLY
template<class Unit1,
class Unit2,
class X,
@@ -619,6 +630,7 @@
};
/// scalar divided by unit typeof helper
+/// INTERNAL ONLY
template<class System,
class Dim,
class X>
@@ -630,6 +642,7 @@
};
/// unit divided by scalar typeof helper
+/// INTERNAL ONLY
template<class System,
class Dim,
class X>
@@ -641,6 +654,7 @@
};
/// scalar divided by quantity typeof helper
+/// INTERNAL ONLY
template<class Unit,
class X,
class Y>
@@ -652,6 +666,7 @@
};
/// quantity divided by scalar typeof helper
+/// INTERNAL ONLY
template<class Unit,
class X,
class Y>
@@ -663,6 +678,7 @@
};
/// unit divided by quantity typeof helper
+/// INTERNAL ONLY
template<class Unit,
class System,
class Dim,
@@ -675,6 +691,7 @@
};
/// quantity divided by unit typeof helper
+/// INTERNAL ONLY
template<class Unit,
class System,
class Dim,
@@ -687,6 +704,7 @@
};
/// quantity divided by quantity typeof helper
+/// INTERNAL ONLY
template<class Unit1,
class Unit2,
class X,
@@ -699,6 +717,7 @@
};
/// specialize power typeof helper
+/// INTERNAL ONLY
template<class Unit,long N,long D,class Y>
struct power_dimof_helper< quantity<Unit,Y>,static_rational<N,D> >
{
@@ -713,6 +732,7 @@
};
/// specialize root typeof helper
+/// INTERNAL ONLY
template<class Unit,long N,long D,class Y>
struct root_typeof_helper< quantity<Unit,Y>,static_rational<N,D> >
{
@@ -727,6 +747,7 @@
};
/// runtime unit times scalar
+/// INTERNAL ONLY
template<class System,
class Dim,
class Y>
Modified: sandbox/units/boost/units/scaled_base_unit.hpp
==============================================================================
--- sandbox/units/boost/units/scaled_base_unit.hpp (original)
+++ sandbox/units/boost/units/scaled_base_unit.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -55,6 +55,7 @@
static value_type value() { return(detail::static_rational_power<Exponent>(static_cast<double>(base))); }
};
+/// INTERNAL ONLY
template<long Base>
struct scale<Base, static_rational<0> >
{
@@ -117,6 +118,7 @@
#endif
+/// INTERNAL ONLY
struct scaled_base_unit_tag {};
template<class S, class Scale>
@@ -167,12 +169,24 @@
namespace units {
+namespace detail {
+
+struct unspecified;
+
+}
+
+/// removes all scaling from a unit or a base unit.
template<class T>
struct unscale
{
+#ifndef BOOST_UNITS_DOXYGEN
typedef T type;
+#else
+ typedef detail::unspecified type;
+#endif
};
+/// INTERNAL ONLY
template<class S, class Scale>
struct unscale<scaled_base_unit<S, Scale> >
{
@@ -182,35 +196,42 @@
template<class D, class S>
class unit;
+/// INTERNAL ONLY
template<class D, class S>
struct unscale<unit<D, S> >
{
typedef unit<D, typename unscale<S>::type> type;
};
+/// INTERNAL ONLY
template<class Scale>
struct scale_list_dim;
+/// INTERNAL ONLY
template<class T>
struct get_scale_list
{
typedef dimensionless_type type;
};
+/// INTERNAL ONLY
template<class S, class Scale>
struct get_scale_list<scaled_base_unit<S, Scale> >
{
typedef typename mpl::times<dimension_list<scale_list_dim<Scale>, dimensionless_type>, typename get_scale_list<S>::type>::type type;
};
+/// INTERNAL ONLY
template<class D, class S>
struct get_scale_list<unit<D, S> >
{
typedef typename get_scale_list<S>::type type;
};
+/// INTERNAL ONLY
struct scale_dim_tag {};
+/// INTERNAL ONLY
template<class Scale>
struct scale_list_dim : Scale
{
@@ -222,6 +243,7 @@
namespace mpl {
+/// INTERNAL ONLY
template<>
struct less_impl<boost::units::scale_dim_tag, boost::units::scale_dim_tag>
{
@@ -266,6 +288,7 @@
}
+/// INTERNAL ONLY
template<class T>
struct eval_scale_list : detail::eval_scale_list_impl<mpl::size<T>::value>::template apply<typename mpl::begin<T>::type> {};
@@ -273,6 +296,7 @@
namespace mpl {
+/// INTERNAL ONLY
template<>
struct plus_impl<boost::units::scale_dim_tag, boost::units::scale_dim_tag>
{
@@ -288,6 +312,7 @@
};
};
+/// INTERNAL ONLY
template<>
struct negate_impl<boost::units::scale_dim_tag>
{
@@ -303,6 +328,7 @@
};
};
+/// INTERNAL ONLY
template<>
struct times_impl<boost::units::scale_dim_tag, boost::units::detail::static_rational_tag>
{
@@ -318,6 +344,7 @@
};
};
+/// INTERNAL ONLY
template<class Tag>
struct less_impl<boost::units::scaled_base_unit_tag, Tag>
{
@@ -327,6 +354,7 @@
((boost::is_same<typename T0::system_type, T1>::value) && ((T0::scale_type::exponent::Numerator) < 0)))> {};
};
+/// INTERNAL ONLY
template<class Tag>
struct less_impl<Tag, boost::units::scaled_base_unit_tag>
{
@@ -336,6 +364,7 @@
((boost::is_same<T0, typename T1::system_type>::value) && ((T1::scale_type::exponent::Numerator) > 0)))> {};
};
+/// INTERNAL ONLY
template<>
struct less_impl<boost::units::scaled_base_unit_tag, boost::units::scaled_base_unit_tag>
{
Modified: sandbox/units/boost/units/unit.hpp
==============================================================================
--- sandbox/units/boost/units/unit.hpp (original)
+++ sandbox/units/boost/units/unit.hpp 2007-08-27 16:49:40 EDT (Mon, 27 Aug 2007)
@@ -86,6 +86,7 @@
#endif
/// unit unary plus typeof helper
+/// INTERNAL ONLY
template<class Dim,class System>
struct unary_plus_typeof_helper< unit<Dim,System> >
{
@@ -93,6 +94,7 @@
};
/// unit unary minus typeof helper
+/// INTERNAL ONLY
template<class Dim,class System>
struct unary_minus_typeof_helper< unit<Dim,System> >
{
@@ -100,6 +102,7 @@
};
/// unit add typeof helper
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System>
@@ -112,6 +115,7 @@
};
/// unit subtract typeof helper
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System>
@@ -124,6 +128,7 @@
};
/// unit multiply typeof helper for two identical homogeneous systems
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System>
@@ -134,6 +139,7 @@
};
/// unit multiply typeof helper for two different homogeneous systems
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System1,
@@ -151,6 +157,7 @@
};
/// unit multiply typeof helper for a heterogeneous and a homogeneous system
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System1,
@@ -168,6 +175,7 @@
};
/// unit multiply typeof helper for a homogeneous and a heterogeneous system
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System1,
@@ -185,6 +193,7 @@
};
/// unit multiply typeof helper for two heterogeneous systems
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System1,
@@ -202,6 +211,7 @@
};
/// unit divide typeof helper for two identical homogeneous systems
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System>
@@ -212,6 +222,7 @@
};
/// unit divide typeof helper for two different homogeneous systems
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System1,
@@ -229,6 +240,7 @@
};
/// unit divide typeof helper for a heterogeneous and a homogeneous system
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System1,
@@ -246,6 +258,7 @@
};
/// unit divide typeof helper for a homogeneous and a heterogeneous system
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System1,
@@ -263,6 +276,7 @@
};
/// unit divide typeof helper for two heterogeneous systems
+/// INTERNAL ONLY
template<class Dim1,
class Dim2,
class System1,
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk