summaryrefslogtreecommitdiff
path: root/number.h
diff options
context:
space:
mode:
authorOlivier Gayot <og@satcom1.com>2017-11-19 17:07:26 +0100
committerOlivier Gayot <og@satcom1.com>2017-11-19 17:09:04 +0100
commit7a514b760baa4e6ec1ba124cd43dd3b2dc7d7d47 (patch)
tree8a8e03018989a53f3c7038e8fb106d73eb67bb9f /number.h
parentc382010ae2e764bf7bbdf467c3d9a115a2113e50 (diff)
Consistently document the methods
Signed-off-by: Olivier Gayot <og@satcom1.com>
Diffstat (limited to 'number.h')
-rw-r--r--number.h18
1 files changed, 9 insertions, 9 deletions
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;