xo-unit: docs extension

This commit is contained in:
Roland Conybeare 2024-05-07 21:48:48 -04:00
commit d767675dd9
11 changed files with 130 additions and 39 deletions

39
docs/basis-unit-class.rst Normal file
View file

@ -0,0 +1,39 @@
.. _basis-unit-class:
Basis Unit
==========
.. code-block:: cpp
#include <xo/unit/basis_unit.hpp>
A :code:`basis_unit` represents a unit belonging to a single native dimension.
For example :code:`bu::meter` representing a distance of 1 meter.
.. doxygenclass:: xo::qty::basis_unit
Constants
---------
.. doxygengroup:: basis-unit-mass-units
.. doxygengroup:: basis-unit-distance-units
Member Variables
----------------
.. doxygengroup:: basis-unit-instance-vars
Constructors
------------
.. doxygengroup:: basis-unit-constructors
Access Methods
--------------
.. doxygengroup:: basis-unit-access-methods
Comparison
----------
.. doxygengroup:: basis-unit-comparison-support