xo-unit: docs: document xo::qty::dimension enum
This commit is contained in:
parent
1a2023a9a2
commit
28023d8a45
5 changed files with 37 additions and 7 deletions
|
|
@ -5,6 +5,6 @@ xo_docdir_doxygen_config()
|
|||
xo_docdir_sphinx_config(
|
||||
index.rst examples.rst glossary.rst install.rst implementation.rst
|
||||
quantity-reference.rst quantity-class.rst quantity-factoryfunctions.rst quantity-unitvars.rst
|
||||
unit-reference.rst unit-concept.rst unit-quantities.rst
|
||||
unit-reference.rst unit-concept.rst unit-quantities.rst dimension-enum.rst
|
||||
)
|
||||
#xo_utest_coverage_config2()
|
||||
|
|
|
|||
16
docs/dimension-enum.rst
Normal file
16
docs/dimension-enum.rst
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
.. _dimension:
|
||||
|
||||
Dimension
|
||||
=========
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
#include <xo/unit/dimension.hpp>
|
||||
|
||||
Identifies an abstract dimension, for example *mass* or *time*.
|
||||
|
||||
.. doxygenenum:: xo::qty::dimension
|
||||
|
||||
.. doxygenvariable:: xo::qty::n_dim
|
||||
|
||||
.. doxygenfunction:: xo::qty::dim2str
|
||||
|
|
@ -21,7 +21,7 @@ Abstraction tower for *xo-unit* components.
|
|||
| dimension |
|
||||
+-----------------------+
|
||||
|
||||
- quantity: see :doc:`quantity-reference`.
|
||||
- quantity: see :doc:`quantity-reference`.
|
||||
quantity with compile-time unit work
|
||||
|
||||
- xquantity:
|
||||
|
|
@ -49,7 +49,7 @@ Abstraction tower for *xo-unit* components.
|
|||
- basis_unit:
|
||||
a unit with a single dimension and scale.
|
||||
|
||||
- dimension:
|
||||
- dimension: see :doc:`dimension-enum`.
|
||||
identifies a dimension, such as mass or time.
|
||||
|
||||
Representation
|
||||
|
|
|
|||
|
|
@ -36,6 +36,7 @@ runtime (since we can't construct new c++ types at runtime).
|
|||
unit-quantities
|
||||
quantity-reference
|
||||
unit-reference
|
||||
dimension-enum
|
||||
|
||||
Indices and Tables
|
||||
------------------
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue