diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 5b784d58..5a9e3e2a 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -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/prefixes.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/utilities.rst" "${CMAKE_CURRENT_SOURCE_DIR}/reference/core/types/utilities/basic_fixed_string.rst" diff --git a/docs/framework/quantity_points.rst b/docs/framework/quantity_points.rst index 4cad2fc3..68219158 100644 --- a/docs/framework/quantity_points.rst +++ b/docs/framework/quantity_points.rst @@ -3,7 +3,7 @@ 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 `quantity_point` class template. diff --git a/docs/reference/core/concepts.rst b/docs/reference/core/concepts.rst index da532c2a..3debd481 100644 --- a/docs/reference/core/concepts.rst +++ b/docs/reference/core/concepts.rst @@ -73,3 +73,8 @@ Concepts 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` must be valid. + +.. concept:: template QuantityPoint + + A concept matching all quantity points in the library. Satisfied by all instantiations of + :class:`quantity_point`. diff --git a/docs/reference/core/types.rst b/docs/reference/core/types.rst index f6fc3164..5113bb2a 100644 --- a/docs/reference/core/types.rst +++ b/docs/reference/core/types.rst @@ -5,6 +5,7 @@ Types :maxdepth: 1 types/quantity + types/quantity_point types/dimensions types/units types/prefixes diff --git a/docs/reference/core/types/quantity_point.rst b/docs/reference/core/types/quantity_point.rst new file mode 100644 index 00000000..3862f035 --- /dev/null +++ b/docs/reference/core/types/quantity_point.rst @@ -0,0 +1,6 @@ +Quantity Point +============== + +.. doxygenclass:: units::quantity_point + :members: + :undoc-members: