Reference section of documentation improved

This commit is contained in:
Mateusz Pusz
2020-05-13 15:36:33 +02:00
parent e58c8054bc
commit e7ac6bd563
14 changed files with 123 additions and 55 deletions
+7
View File
@@ -0,0 +1,7 @@
Customization Points
====================
.. doxygenvariable:: units::treat_as_floating_point
.. doxygenstruct:: units::quantity_values
:members:
+12 -8
View File
@@ -1,15 +1,19 @@
.. note::
All names defined in this chapter reside in the :any:`units` namespace unless specified otherwise.
Functions
=========
.. doxygenfunction:: quantity_cast
Casting and Converions
----------------------
.. doxygenfunction:: units::quantity_cast
Math
----
Metafunctions
=============
.. doxygenfunction:: units::pow
.. doxygentypedef:: dimension_unit
.. doxygenfunction:: units::sqrt
.. doxygenfunction:: units::abs
.. doxygenfunction:: units::epsilon
+4
View File
@@ -0,0 +1,4 @@
Metafunctions
=============
.. doxygentypedef:: dimension_unit
+7 -47
View File
@@ -1,51 +1,11 @@
.. note::
All names defined in this chapter reside in the :any:`units` namespace unless specified otherwise.
Types
=====
Quantity
--------
.. toctree::
:maxdepth: 1
.. 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:
types/quantity
types/dimensions
types/units
types/prefixes
types/utilities
+11
View File
@@ -0,0 +1,11 @@
Dimensions
==========
.. doxygenstruct:: units::base_dimension
:members:
.. doxygenstruct:: units::exp
:members:
.. doxygenstruct:: units::derived_dimension
:members:
+11
View File
@@ -0,0 +1,11 @@
Prefixes
========
.. doxygenstruct:: units::prefix_family
:members:
.. doxygenstruct:: units::no_prefix
:members:
.. doxygenstruct:: units::prefix
:members:
+6
View File
@@ -0,0 +1,6 @@
Quantity
========
.. doxygenclass:: units::quantity
:members:
:undoc-members:
+26
View File
@@ -0,0 +1,26 @@
Units
=====
.. 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:
.. doxygenstruct:: units::alias_unit
:members:
.. doxygenstruct:: units::prefixed_alias_unit
:members:
+9
View File
@@ -0,0 +1,9 @@
Utilities
=========
.. toctree::
:maxdepth: 1
utilities/ratio
utilities/basic_symbol_text
utilities/basic_fixed_string
@@ -0,0 +1,6 @@
basic_fixed_string
==================
.. doxygenstruct:: units::basic_fixed_string
:members:
:undoc-members:
@@ -0,0 +1,6 @@
basic_symbol_text
=================
.. doxygenstruct:: units::basic_symbol_text
:members:
:undoc-members:
+6
View File
@@ -0,0 +1,6 @@
ratio
=====
.. doxygenstruct:: units::ratio
:members:
:undoc-members: