From 6a8bfc39da6d11b36e94167f5b620021884b0ca0 Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Fri, 19 Apr 2024 07:18:41 -0400 Subject: [PATCH] xo-ratio: docs: + .rst files ratio-reference/functions/class --- docs/index.rst | 1 + docs/ratio-class.rst | 47 ++++++++++++++++++++++++++++++++++++++++ docs/ratio-functions.rst | 17 +++++++++++++++ docs/ratio-reference.rst | 11 ++++++++++ 4 files changed, 76 insertions(+) create mode 100644 docs/ratio-class.rst create mode 100644 docs/ratio-functions.rst create mode 100644 docs/ratio-reference.rst diff --git a/docs/index.rst b/docs/index.rst index bf85e687..849e2e15 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,6 +26,7 @@ Why ``ratio``? :caption: xo-ratio contents: install + ratio-reference Indices and Tables ------------------ diff --git a/docs/ratio-class.rst b/docs/ratio-class.rst new file mode 100644 index 00000000..2cd56798 --- /dev/null +++ b/docs/ratio-class.rst @@ -0,0 +1,47 @@ +.. _ratio-class: + +Ratio +===== + +.. code-block:: cpp + + #include + +A ``ratio`` represents an exact fraction of two integers. + +.. doxygenclass:: xo::ratio::ratio + +Instance Variables +------------------ + +.. doxygengroup:: ratio-instance-variables + +Types +----- + +.. doxygengroup:: ratio-types + +Constructors +------------ + +.. doxygengroup:: ratio-ctor + +Static Methods +-------------- + +.. doxygengroup:: ratio-static-methods + +Access Methods +-------------- + +.. doxygengroup:: ratio-access + +General Methods +--------------- + +.. doxygengroup:: ratio-methods + +Conversion +---------- + +.. doxygengroup:: ratio-conversion diff --git a/docs/ratio-functions.rst b/docs/ratio-functions.rst new file mode 100644 index 00000000..7553e8c0 --- /dev/null +++ b/docs/ratio-functions.rst @@ -0,0 +1,17 @@ +.. _ratio_functions: + +.. toctree:: + :maxdepth: 2 + +Ratio Functions +=============== + +.. code-block:: cpp + + #include + +.. doxygenfunction:: xo::ratio::make_ratio + +.. doxygengroup:: ratio-arithmetic + +.. doxygengroup:: ratio-3way-compare diff --git a/docs/ratio-reference.rst b/docs/ratio-reference.rst new file mode 100644 index 00000000..621d2075 --- /dev/null +++ b/docs/ratio-reference.rst @@ -0,0 +1,11 @@ +.. _ratio-reference: + +Ratio Reference +=============== + +.. toctree:: + :maxdepth: 2 + :caption: Ratio Reference + + ratio-class + ratio-functions