Sphinx-based documentation added

This commit is contained in:
Mateusz Pusz
2020-03-09 18:55:41 +01:00
parent af6358fbdb
commit b65328d575
88 changed files with 6476 additions and 154 deletions
+62
View File
@@ -0,0 +1,62 @@
Concepts
========
.. namespace:: units
.. note::
All names defined in this chapter reside in the :any:`units` namespace unless specified otherwise.
.. concept:: template<typename T> PrefixType
Satisfied by all types derived from :class:`prefix_type`.
.. concept:: template<typename T> Prefix
Satisfied by all instantiations of :class:`prefix`.
.. concept:: template<typename T> Ratio
Satisfied by all instantiations of :class:`ratio`.
.. concept:: template<typename R> UnitRatio
Satisfied by all types that satisfy :expr:`Ratio<R>` and for which :expr:`R::num > 0` and :expr:`R::den > 0`.
.. concept:: template<typename T> BaseDimension
Satisfied by all dimension types derived from instantiation of :class:`base_dimension`.
.. concept:: template<typename T> Exponent
Satisfied by all instantiations of :class:`exp`.
.. concept:: template<typename T> DerivedDimension
Satisfied by all dimension types derived from instantiation of :class:`detail::derived_dimension_base`.
.. concept:: template<typename T> Dimension
Satisfied by all dimension types for which either :expr:`BaseDimension<T>` or :expr:`DerivedDimension<T>` is ``true``.
.. concept:: template<typename T> Unit
Satisfied by all unit types derived from instantiation of :class:`scaled_unit`.
.. concept:: template<typename U, typename D> UnitOf
Satisfied by all unit types that satisfy :expr:`Unit<U>`, :expr:`Dimension<D>`, and for which
:expr:`U::reference` and :expr:`dimension_unit<D>::reference` denote the same unit type.
.. concept:: template<typename T> Quantity
Satisfied by all instantiations of :class:`quantity`.
.. concept:: template<typename T> WrappedQuantity
Satisfied by all wrapper types that satisfy :expr:`Quantity<typename T::value_type>` recursively
(i.e. :expr:`std::optional<si::length<si::metre>>`).
.. concept:: template<typename T> Scalar
Satisfied by types that satisfy :expr:`(!Quantity<T>) && (!WrappedQuantity<T>) && std::regular<T>`.
+15
View File
@@ -0,0 +1,15 @@
.. note::
All names defined in this chapter reside in the :any:`units` namespace unless specified otherwise.
Functions
=========
.. doxygenfunction:: quantity_cast
Metafunctions
=============
.. doxygentypedef:: dimension_unit
+32
View File
@@ -0,0 +1,32 @@
.. note::
All names defined in this chapter reside in the :any:`units` namespace unless specified otherwise.
Systems
=======
SI
--
..
doxygennamespace:: units::si
:members:
:undoc-members:
:outline:
File
----
..
doxygenfile:: si/length.h
Group
-----
..
doxygengroup:: si_length
:content-only:
:members:
:undoc-members:
:outline:
+51
View File
@@ -0,0 +1,51 @@
.. note::
All names defined in this chapter reside in the :any:`units` namespace unless specified otherwise.
Types
=====
Quantity
--------
.. doxygenclass:: units::quantity
:members:
..
:undoc-members:
Dimension
---------
.. doxygenstruct:: units::base_dimension
:members:
.. doxygenstruct:: units::derived_dimension
:members:
Unit
----
.. doxygenstruct:: units::scaled_unit
:members:
.. doxygenstruct:: units::unit
:members:
.. doxygenstruct:: units::named_unit
:members:
.. doxygenstruct:: units::named_scaled_unit
:members:
.. doxygenstruct:: units::prefixed_unit
:members:
.. doxygenstruct:: units::deduced_unit
:members:
Ratio
-----
.. doxygenstruct:: units::ratio
:members: