xo-unit: docs extension

docs/CMakeLists.txt

@@ -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 dimension-enum.rst
+    unit-reference.rst unit-concept.rst unit-quantities.rst basis-unit-class.rst dimension-enum.rst
 )
 #xo_utest_coverage_config2()

docs/basis-unit-class.rst

@@ -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

docs/implementation.rst

@@ -47,12 +47,15 @@ Abstraction tower for *xo-unit* components.
     (for example consider :code:`xo::qty::qty::foot * xo::qty::qty::meter`)
 
 - bpu:
-  a power of a basis unit. Has a single dimension.
 
-- basis_unit:
-  a unit with a single dimension and scale.
+  A power of a basis unit. Has a single dimension.
+
+- basis_unit: see :doc:`basis-unit-class`.
+
+  A unit with a single dimension and scale.
 
 - dimension: see :doc:`dimension-enum`.
+
   identifies a dimension, such as mass or time.
 
 Representation

docs/index.rst

@@ -36,6 +36,7 @@ runtime (since we can't construct new c++ types at runtime).
    unit-quantities
    quantity-reference
    unit-reference
+   basis-unit-class
    dimension-enum
 
 Indices and Tables

docs/quantity-class.rst

@@ -17,6 +17,12 @@ Type Traits
 
 .. doxygengroup:: quantity-type-traits
 
+Member Variables
+----------------
+
+.. doxygengroup:: quantity-static-vars
+.. doxygengroup:: quantity-instance-vars
+
 Constructors
 ------------
 
@@ -61,13 +67,11 @@ Arithmetic
 
 Support methods for arithmetic operations
 
-.. doxygengroup:: quantity-arithmeticsupport
-   :content-only:
+.. doxygengroup:: quantity-arithmetic-support
 
 Comparison
 ----------
 
 Support methods for comparison operators
 
-.. doxygengroup:: quantity-comparisonsupport
-   :content-only:
+.. doxygengroup:: quantity-comparison-support