From 7a514b760baa4e6ec1ba124cd43dd3b2dc7d7d47 Mon Sep 17 00:00:00 2001 From: Olivier Gayot Date: Sun, 19 Nov 2017 17:07:26 +0100 Subject: Consistently document the methods Signed-off-by: Olivier Gayot --- number.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'number.h') diff --git a/number.h b/number.h index c920ddc..5043f1b 100644 --- a/number.h +++ b/number.h @@ -63,15 +63,15 @@ public: number operator<<(std::uint32_t n) const; /** - * \brief Tells whether the number passed as parameter is strictly less - * than this number. + * \brief Tell whether the number passed as parameter is strictly less than + * this number. * * \param n The number to compare with this number. */ bool operator<(const number &n) const; /** - * \brief Tells whether the number passed as parameter is strictly greater + * \brief Tell whether the number passed as parameter is strictly greater * than this number. * * \param n The number to compare with this number. @@ -79,15 +79,15 @@ public: bool operator>(const number &n) const; /** - * \brief Tells whether the number passed as parameter is less than or - * equal to this number. + * \brief Tell whether the number passed as parameter is less than or equal + * to this number. * * \param n The number to compare with this number. */ bool operator<=(const number &n) const; /** - * \brief Tells whether the number passed as parameter is greater than or + * \brief Tell whether the number passed as parameter is greater than or * equal to this number. * * \param n The number to compare with this number. @@ -95,7 +95,7 @@ public: bool operator>=(const number &n) const; /** - * \brief Tells whether the number passed as parameter is equal to this + * \brief Tell whether the number passed as parameter is equal to this * number. * * \param n The number to compare with this number. @@ -103,7 +103,7 @@ public: bool operator==(const number &n) const; /** - * \brief Tells whether the number passed as parameter is not equal to this + * \brief Tell whether the number passed as parameter is not equal to this * number. * * \param n The number to compare with this number. @@ -111,7 +111,7 @@ public: bool operator!=(const number &n) const; /** - * \brief Tells whether this number evaluates to false. + * \brief Tell whether this number evaluates to false. */ bool operator!() const; -- cgit v1.2.3