From f28c9f7b0fe9822476a57315469d437edd0877c0 Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Thu, 9 May 2024 10:39:54 -0400 Subject: [PATCH] xo-unit: bpu ++ docs --- include/xo/unit/bpu.hpp | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/include/xo/unit/bpu.hpp b/include/xo/unit/bpu.hpp index dbd2483b..662dd0ca 100644 --- a/include/xo/unit/bpu.hpp +++ b/include/xo/unit/bpu.hpp @@ -87,10 +87,13 @@ namespace xo { /** @defgroup bpu-access-methods bpu access methods **/ ///@{ - /** @brief report this bpu's @ref basis_unit **/ + /** @brief report this bpu's @ref basis_unit, e.g. @c detail::bu::minute **/ constexpr const basis_unit & bu() const { return bu_; } + /** @brief report this bpu's @ref dimension, e.g. @c dimension::time **/ constexpr dimension native_dim() const { return bu_.native_dim(); } + /** @brief report this bpu's scale factor, e.g. @c 60/1 for @c detail::bu::minute **/ constexpr const scalefactor_ratio_type & scalefactor() const { return bu_.scalefactor(); } + /** @brief report this bpu's exponent, e.g. @c 3/1 for bpu representing cubic meters **/ constexpr const power_ratio_type & power() const { return power_; } ///@}