docs: quantity_point documentation fixed

This commit is contained in:
Mateusz Pusz
2020-09-08 18:43:00 +02:00
parent 8cc784aa28
commit 4cec29972f
5 changed files with 14 additions and 1 deletions

View File

@@ -124,6 +124,7 @@ add_custom_command(OUTPUT "${SPHINX_INDEX_FILE}"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/dimensions.rst" "${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/dimensions.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/prefixes.rst" "${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/prefixes.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/quantity.rst" "${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/quantity.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/quantity_point.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/units.rst" "${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/units.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/utilities.rst" "${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/utilities.rst"
"${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/utilities/basic_fixed_string.rst" "${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/utilities/basic_fixed_string.rst"

View File

@@ -3,7 +3,7 @@
Quantity Points Quantity Points
=============== ===============
A :term:`quantity point` is an absolute quantity with respect to zero A `quantity point` is an absolute quantity with respect to zero
(which represents some origin) and is represented in the library with a (which represents some origin) and is represented in the library with a
`quantity_point` class template. `quantity_point` class template.

View File

@@ -73,3 +73,8 @@ Concepts
the elements of `ratio`), :expr:`T * T` and :expr:`T / T` must be valid, the elements of `ratio`), :expr:`T * T` and :expr:`T / T` must be valid,
- otherwise, :expr:`T * std::int64_t`, :expr:`std::int64_t * T`, and :expr:`T / std::int64_t` - otherwise, :expr:`T * std::int64_t`, :expr:`std::int64_t * T`, and :expr:`T / std::int64_t`
must be valid. must be valid.
.. concept:: template<typename T> QuantityPoint
A concept matching all quantity points in the library. Satisfied by all instantiations of
:class:`quantity_point`.

View File

@@ -5,6 +5,7 @@ Types
:maxdepth: 1 :maxdepth: 1
types/quantity types/quantity
types/quantity_point
types/dimensions types/dimensions
types/units types/units
types/prefixes types/prefixes

View File

@@ -0,0 +1,6 @@
Quantity Point
==============
.. doxygenclass:: units::quantity_point
:members:
:undoc-members: