feedc0de/mp-units
1
0
Fork 0
forked from mpusz/mp-units
Code Pull Requests Activity

docs: project documentation updated with the latest unit-related changes

Browse Source
This commit is contained in:
Mateusz Pusz
2022-05-11 16:28:14 +02:00
parent 5300caf17b
commit 01271a90b6
6 changed files with 206 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/core/concepts.rst
+5 -4
View File
@@ -8,10 +8,6 @@ Concepts
All names defined in this chapter reside in the :any:`units` namespace unless
specified otherwise.
.. concept:: template<typename T> PrefixFamily
A concept matching a prefix family. Satisfied by all types derived from :class:`prefix_family`.
.. concept:: template<typename T> Prefix
A concept matching a symbol prefix. Satisfied by all instantiations of :struct:`prefix`.
@@ -44,6 +40,11 @@ Concepts
A concept matching all unit types in the library. Satisfied by all unit types derived
from the instantiation of :class:`scaled_unit`.
.. concept:: template<typename T> NamedUnit
A concept matching all unit types that have an atomic text symbol that can be used to aggregate it with
other named units to form a final symbol of a derived unit.
.. concept:: template<typename U, typename D> UnitOf
A concept matching only units of a specified dimension. Satisfied by all unit types that
docs/reference/core/types/prefixes.rst
-6
View File
@@ -1,11 +1,5 @@
Prefixes
========
.. doxygenstruct:: units::prefix_family
:members:
.. doxygenstruct:: units::no_prefix
:members:
.. doxygenstruct:: units::prefix
:members:
docs/reference/core/types/units.rst
+1 -4
View File
@@ -4,9 +4,6 @@ Units
.. doxygenstruct:: units::scaled_unit
:members:
.. doxygenstruct:: units::unit
:members:
.. doxygenstruct:: units::named_unit
:members:
@@ -19,7 +16,7 @@ Units
.. doxygenstruct:: units::derived_unit
:members:
.. doxygenstruct:: units::named_derived_unit
.. doxygenstruct:: units::derived_scaled_unit
:members:
.. doxygenstruct:: units::alias_unit