xo-expression2/docs
2024-05-23 15:01:56 -04:00
..
_static xo-unit: docs: + _static dir 2024-04-03 14:58:11 -04:00
basis-unit-class.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
basis-unit-constants.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
basis-unit-reference.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
bpu-class.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
bu-store-class.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
CMakeLists.txt xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
conf.py xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
development.rst xo-unit: kitchen-sink doc + build improvements + 1 bug fix 2024-05-22 15:16:17 -04:00
dimension-enum.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
examples.rst xo-unit: kitchen-sink doc + build improvements + 1 bug fix 2024-05-22 15:16:17 -04:00
glossary.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
implementation.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
index.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
install.rst xo-unit: quantity refactoring 2024-05-23 15:01:56 -04:00
natural-unit-class.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
quantity-class.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
quantity-factoryfunctions.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
quantity-reference.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
quantity-source-code.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
quantity-unitvars.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
README xo-unit: ++ documentation for bu_store 2024-05-19 17:53:03 -04:00
scaled-unit-class.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
scaled-unit-constants.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
scaled-unit-reference.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
ubuntu-github-workflow.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
xquantity-class.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00
xquantity-reference.rst xo-unit ++ docs ++ quantity arithmetic + example 2024-05-23 14:44:00 -04:00

build

        +-----------------------------------------------+
        | cmake                                         |
        |   CMakeLists.txt                              |
        |   $PREFIX/share/cmake/xo_macros/xo_cxx.cmake  |
        +-----------------------------------------------+
           |
           |                                                  +----------------------+
           +------------------------------------------------->| .build/docs/Doxyfile |
           |                                                  +----------------------+
           |                                                     |
           |                                        /------------/
           |                                        |
           |                                        v
           |     +---------------------------------------+    +-----------------+
           +---->| doxygen                               |--->| .build/docs/dox |
           |     |   $PREFIX/share/xo-macros/Doxyfile.in |    |   +- html/      |
           |     +---------------------------------------+    |   +- xml/       |
           |                                                  +-----------------+
           |                                                     |
           |                                        /------------/
           |                                        |
           |                                        v
           |     +---------------------------------------+    +--------------------+
           \---->| sphinx                                |--->| .build/docs/sphinx |
                 |   +- conf.py                          |    |   +- html/         |
                 |   +- _static/                         |    +--------------------+
                 |   +- *.rst                            |
                 +---------------------------------------+

files

   README            this file
   CMakeLists.txt    build entry point
   conf.py           sphinx config
   _static           static files for sphinx

map

   index.rst
   +- install.rst
   +- examples.rst
   +- unit-quantities.rst
   +- classes.rst
   +- glossary.rst
   ...

examples

.. doxygenclass:: ${c++ class name}
   :project:
   :path:
   :members:
   :protected-members:
   :private-members:
   :undoc-members:
   :member-groups:
   :members-only:
   :outline:
   :no-link:
   :allow-dot-graphs:

.. doxygendefine:: ${c preprocessor define}

.. doxygenconcept:: ${c++ concept definition}

.. doxygenenum:: ${c++ enum definition}

.. doxygenfunction:: ${c++ function name}