From 425d53dc90d6a842d42250bae2579134cbdc3282 Mon Sep 17 00:00:00 2001 From: Leonetienne Date: Sun, 27 Feb 2022 19:54:10 +0100 Subject: [PATCH] Better incomment documentation --- Src/BaseConversion.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Src/BaseConversion.h b/Src/BaseConversion.h index d8fb192..37bd1b4 100644 --- a/Src/BaseConversion.h +++ b/Src/BaseConversion.h @@ -12,6 +12,7 @@ class BaseConversion { public: //! Will divide a number of arbitrary base in `dividend` by an integer divisor. //! This is a specific helper function for the base conversion functions. + //! \tparam T_Container The type of container used for the digitstring //! \param dividend The number to be divided in listlike container-form (such as a string) //! \param divisor The integer divisor //! \param set The set/base of `dividend` @@ -20,6 +21,7 @@ public: static std::pair DigitstringDivision(const T_Container& dividend, const unsigned int divisor, const T_Container& set); //! Will convert a number of arbitrary base to base 10 + //! \tparam T_Container The type of container used for the digitstring //! \param num A listlike container representing the number (such as a string) //! \param set The set/base of the number //! \return A 64-bit integer representing the number @@ -28,6 +30,7 @@ public: //! Will convert a number to an arbitrary base. //! This just a wrapper for BaseX_2_Y. + //! \tparam T_Container The type of container used for the digitstring //! \param num The number to be converted //! \param set The desired set/base for the output to be in. Should be a listlike container (such as a string) //! \return `num` in base `set` @@ -35,6 +38,8 @@ public: static T_Container Base10_2_X(const std::uint64_t& num, const T_Container& set, const std::uint32_t minOutLen = 1); //! Will convert a number from an arbitrary base to another arbitrary base. + //! \tparam T_ContainerIn The type of container used for the incoming digitstring + //! \tparam T_ContainerOut The type of container used for the outgoing digitstring //! \param num A representation of a number in a listlike container (such as a string) //! \param set_in The set/base of the input //! \param set_out The desired set/base to output