--- a/src/lte/model/lte-rlc-sequence-number.h Thu Jun 01 16:57:22 2017 -0700
+++ b/src/lte/model/lte-rlc-sequence-number.h Fri Jun 02 14:45:29 2017 +0200
@@ -99,7 +99,10 @@
m_modulusBase = modulusBase;
}
- /// postfix ++ operator
+ /**
+ * postfix ++ operator
+ * \returns SequenceNumber10
+ */
SequenceNumber10 operator++ (int)
{
SequenceNumber10 retval (m_value);
@@ -108,7 +111,11 @@
return retval;
}
- /// addition operator
+ /**
+ * addition operator
+ * \param delta the amount to add
+ * \returns SequenceNumber10
+ */
SequenceNumber10 operator + (uint16_t delta) const
{
SequenceNumber10 ret ((m_value + delta) % 1024);
@@ -116,7 +123,11 @@
return ret;
}
- /// subtraction operator
+ /**
+ * subtraction operator
+ * \param delta the amount to subtract
+ * \returns SequenceNumber10
+ */
SequenceNumber10 operator - (uint16_t delta) const
{
SequenceNumber10 ret ((m_value - delta) % 1024);
@@ -124,14 +135,22 @@
return ret;
}
- /// subtraction operator
+ /**
+ * subtraction operator
+ * \param other the amount to subtract
+ * \returns SequenceNumber10
+ */
uint16_t operator - (const SequenceNumber10 &other) const
{
uint16_t diff = m_value - other.m_value;
return (diff);
}
- /// greater than operator
+ /**
+ * greater than operator
+ * \param other the object to compare
+ * \returns true if greater than
+ */
bool operator > (const SequenceNumber10 &other) const
{
SequenceNumber10 v1 ((m_value - m_modulusBase) % 1024);
@@ -139,31 +158,51 @@
return ( v1.GetValue () > v2.GetValue () );
}
- /// equaity operator
+ /**
+ * equality operator
+ * \param other the object to compare
+ * \returns true if equal
+ */
bool operator == (const SequenceNumber10 &other) const
{
return (m_value == other.m_value);
}
- /// inequality operator
+ /**
+ * inequality operator
+ * \param other the object to compare
+ * \returns true if not equal
+ */
bool operator != (const SequenceNumber10 &other) const
{
return (m_value != other.m_value);
}
- /// less than or equal operator
+ /**
+ * less than or equal operator
+ * \param other the object to compare
+ * \returns true if less than or equal
+ */
bool operator <= (const SequenceNumber10 &other) const
{
return (!this->operator> (other));
}
- /// greater than or equal operator
+ /**
+ * greater than or equal operator
+ * \param other the object to compare
+ * \returns true if greater than or equal
+ */
bool operator >= (const SequenceNumber10 &other) const
{
return (this->operator> (other) || this->operator== (other));
}
- /// less than operator
+ /**
+ * less than operator
+ * \param other the object to compare
+ * \returns true if less than
+ */
bool operator < (const SequenceNumber10 &other) const
{
return !this->operator> (other) && m_value != other.m_value;