-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
xo-ratio: docs: + .rst files ratio-reference/functions/class
- Loading branch information
Showing
4 changed files
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
.. _ratio-class: | ||
|
||
Ratio | ||
===== | ||
|
||
.. code-block:: cpp | ||
#include <xo/ratio/ratio.hpp> | ||
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
.. _ratio_functions: | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
Ratio Functions | ||
=============== | ||
|
||
.. code-block:: cpp | ||
#include <xo/ratio/ratio.hpp> | ||
.. doxygenfunction:: xo::ratio::make_ratio | ||
|
||
.. doxygengroup:: ratio-arithmetic | ||
|
||
.. doxygengroup:: ratio-3way-compare |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
.. _ratio-reference: | ||
|
||
Ratio Reference | ||
=============== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Ratio Reference | ||
|
||
ratio-class | ||
ratio-functions |