F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix Doxygen comment formatting and typos

Browse Source
This commit is contained in:
Eduardo Almeida
2022-10-16 14:49:21 +01:00
parent 33ff238ccb
commit 85ade4e18d
122 changed files with 1112 additions and 878 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/core/model/int64x64-128.h
View File

@@ -339,10 +339,10 @@ class int64x64_t
*/
/**
* @{
* Arithmetic operator.
* \param [in] lhs Left hand argument
* \param [in] rhs Right hand argument
* \return The result of the operator.
* Arithmetic operator.
* \param [in] lhs Left hand argument
* \param [in] rhs Right hand argument
* \return The result of the operator.
*/
friend inline bool operator==(const int64x64_t& lhs, const int64x64_t& rhs)
@@ -364,25 +364,25 @@ class int64x64_t
{
lhs._v += rhs._v;
return lhs;
};
}
friend inline int64x64_t& operator-=(int64x64_t& lhs, const int64x64_t& rhs)
{
lhs._v -= rhs._v;
return lhs;
};
}
friend inline int64x64_t& operator*=(int64x64_t& lhs, const int64x64_t& rhs)
{
lhs.Mul(rhs);
return lhs;
};
}
friend inline int64x64_t& operator/=(int64x64_t& lhs, const int64x64_t& rhs)
{
lhs.Div(rhs);
return lhs;
};
}
/**@}*/
@@ -392,24 +392,24 @@ class int64x64_t
*/
/**
* @{
* Unary operator.
* \param [in] lhs Left hand argument
* \return The result of the operator.
* Unary operator.
* \param [in] lhs Left hand argument
* \return The result of the operator.
*/
friend inline int64x64_t operator+(const int64x64_t& lhs)
{
return lhs;
};
}
friend inline int64x64_t operator-(const int64x64_t& lhs)
{
return int64x64_t(-lhs._v);
};
}
friend inline int64x64_t operator!(const int64x64_t& lhs)
{
return int64x64_t(!lhs._v);
};
}
/**@}*/

28
src/core/model/int64x64-cairo.h
View File

@@ -315,10 +315,10 @@ class int64x64_t
*/
/**
* @{
* Arithmetic operator.
* \param [in] lhs Left hand argument
* \param [in] rhs Right hand argument
* \return The result of the operator.
* Arithmetic operator.
* \param [in] lhs Left hand argument
* \param [in] rhs Right hand argument
* \return The result of the operator.
*/
friend inline bool operator==(const int64x64_t& lhs, const int64x64_t& rhs)
@@ -340,25 +340,25 @@ class int64x64_t
{
lhs._v = _cairo_int128_add(lhs._v, rhs._v);
return lhs;
};
}
friend inline int64x64_t& operator-=(int64x64_t& lhs, const int64x64_t& rhs)
{
lhs._v = _cairo_int128_sub(lhs._v, rhs._v);
return lhs;
};
}
friend inline int64x64_t& operator*=(int64x64_t& lhs, const int64x64_t& rhs)
{
lhs.Mul(rhs);
return lhs;
};
}
friend inline int64x64_t& operator/=(int64x64_t& lhs, const int64x64_t& rhs)
{
lhs.Div(rhs);
return lhs;
};
}
/** @} */
@@ -368,26 +368,26 @@ class int64x64_t
*/
/**
* @{
* Unary operator.
* \param [in] lhs Left hand argument
* \return The result of the operator.
* Unary operator.
* \param [in] lhs Left hand argument
* \return The result of the operator.
*/
friend inline int64x64_t operator+(const int64x64_t& lhs)
{
return lhs;
};
}
friend inline int64x64_t operator-(const int64x64_t& lhs)
{
int64x64_t tmp = lhs;
tmp._v = _cairo_int128_negate(tmp._v);
return tmp;
};
}
friend inline int64x64_t operator!(const int64x64_t& lhs)
{
return (lhs == int64x64_t()) ? int64x64_t(1, 0) : int64x64_t();
};
}
/** @} */

28
src/core/model/int64x64-double.h
View File

@@ -316,10 +316,10 @@ class int64x64_t
*/
/*
* @{
* Arithmetic operator.
* \param [in] lhs Left hand argument
* \param [in] rhs Right hand argument
* \return The result of the operator.
* Arithmetic operator.
* \param [in] lhs Left hand argument
* \param [in] rhs Right hand argument
* \return The result of the operator.
*/
friend inline bool operator==(const int64x64_t& lhs, const int64x64_t& rhs)
@@ -341,25 +341,25 @@ class int64x64_t
{
lhs._v += rhs._v;
return lhs;
};
}
friend inline int64x64_t& operator-=(int64x64_t& lhs, const int64x64_t& rhs)
{
lhs._v -= rhs._v;
return lhs;
};
}
friend inline int64x64_t& operator*=(int64x64_t& lhs, const int64x64_t& rhs)
{
lhs._v *= rhs._v;
return lhs;
};
}
friend inline int64x64_t& operator/=(int64x64_t& lhs, const int64x64_t& rhs)
{
lhs._v /= rhs._v;
return lhs;
};
}
/**@}*/
@@ -369,24 +369,24 @@ class int64x64_t
*/
/*
* @{
* Unary operator.
* \param [in] lhs Left hand argument
* \return The result of the operator.
* Unary operator.
* \param [in] lhs Left hand argument
* \return The result of the operator.
*/
friend inline int64x64_t operator+(const int64x64_t& lhs)
{
return lhs;
};
}
friend inline int64x64_t operator-(const int64x64_t& lhs)
{
return int64x64_t(-lhs._v);
};
}
friend inline int64x64_t operator!(const int64x64_t& lhs)
{
return int64x64_t(!lhs._v);
};
}
/**@}*/

42
src/core/model/nstime.h
View File

@@ -174,13 +174,13 @@ class Time
/**
* \name Numeric constructors
* Construct from a numeric value.
* Construct from a numeric value.
* @{
*/
/**
* Construct from a numeric value.
* The current time resolution will be assumed as the unit.
* \param [in] v The value.
* Construct from a numeric value.
* The current time resolution will be assumed as the unit.
* \param [in] v The value.
*/
explicit inline Time(double v)
: m_data(llround(v))
@@ -472,10 +472,10 @@ class Time
static enum Unit GetResolution();
/**
* Create a Time in the current unit.
* Create a Time in the current unit.
*
* \param [in] value The value of the new Time.
* \return A Time with \pname{value} in the current time unit.
* \param [in] value The value of the new Time.
* \return A Time with \pname{value} in the current time unit.
*/
inline static Time From(const int64x64_t& value)
{
@@ -489,11 +489,11 @@ class Time
* @{
*/
/**
* Create a Time equal to \pname{value} in unit \c unit
* Create a Time equal to \pname{value} in unit \c unit
*
* \param [in] value The new Time value, expressed in \c unit
* \param [in] unit The unit of \pname{value}
* \return The Time representing \pname{value} in \c unit
* \param [in] value The new Time value, expressed in \c unit
* \param [in] unit The unit of \pname{value}
* \return The Time representing \pname{value} in \c unit
*/
inline static Time FromInteger(uint64_t value, enum Unit unit)
{
@@ -540,10 +540,10 @@ class Time
* @{
*/
/**
* Get the Time value expressed in a particular unit.
* Get the Time value expressed in a particular unit.
*
* \param [in] unit The desired unit
* \return The Time expressed in \pname{unit}
* \param [in] unit The desired unit
* \return The Time expressed in \pname{unit}
*/
inline int64_t ToInteger(enum Unit unit) const
{
@@ -636,7 +636,7 @@ class Time
/**
* Get the current Resolution
*
* \return A pointer to the current Resolution
* \return A pointer to the current Resolution
*/
static inline struct Resolution* PeekResolution()
{
@@ -658,7 +658,7 @@ class Time
/**
* Set the default resolution
*
* \return The Resolution object for the default resolution.
* \return The Resolution object for the default resolution.
*/
static struct Resolution& SetDefaultNsResolution();
/**
@@ -1439,7 +1439,7 @@ MakeTimeChecker()
* \ingroup attribute_time
* Helper to make a Time checker with a lower bound.
*
* \param [in] min Minimum allowed value.
* \param [in] min Minimum allowed value.
* \return The AttributeChecker
*/
inline Ptr<const AttributeChecker>
@@ -1472,10 +1472,10 @@ class TimeWithUnit
Time::Unit m_unit; //!< The unit to use in output
/**
* Output streamer
* \param [in,out] os The stream.
* \param [in] timeU The Time with desired unit
* \returns The stream.
* Output streamer
* \param [in,out] os The stream.
* \param [in] timeU The Time with desired unit
* \returns The stream.
*/
friend std::ostream& operator<<(std::ostream& os, const TimeWithUnit& timeU);

139
src/core/model/random-variable-stream.h
View File

@@ -651,9 +651,11 @@ class ParetoRandomVariable : public RandomVariableStream
/**
* \brief Returns a random double from a Pareto distribution with the specified scale, shape,
* and upper bound. \param [in] scale Mean parameter for the Pareto distribution. \param [in]
* shape Shape parameter for the Pareto distribution. \param [in] bound Upper bound on values
* returned. \return A floating point random value.
* and upper bound.
* \param [in] scale Mean parameter for the Pareto distribution.
* \param [in] shape Shape parameter for the Pareto distribution.
* \param [in] bound Upper bound on values returned.
* \return A floating point random value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -678,9 +680,11 @@ class ParetoRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a Pareto distribution with the specified mean,
* shape, and upper bound. \param [in] scale Scale parameter for the Pareto distribution. \param
* [in] shape Shape parameter for the Pareto distribution. \param [in] bound Upper bound on
* values returned. \return A random unsigned integer value.
* shape, and upper bound.
* \param [in] scale Scale parameter for the Pareto distribution.
* \param [in] shape Shape parameter for the Pareto distribution.
* \param [in] bound Upper bound on values returned.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -705,7 +709,8 @@ class ParetoRandomVariable : public RandomVariableStream
/**
* \brief Returns a random double from a Pareto distribution with the current mean, shape, and
* upper bound. \return A floating point random value.
* upper bound.
* \return A floating point random value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -739,7 +744,8 @@ class ParetoRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a Pareto distribution with the current mean,
* shape, and upper bound. \return A random unsigned integer value.
* shape, and upper bound.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -865,9 +871,11 @@ class WeibullRandomVariable : public RandomVariableStream
/**
* \brief Returns a random double from a Weibull distribution with the specified scale, shape,
* and upper bound. \param [in] scale Scale parameter for the Weibull distribution. \param [in]
* shape Shape parameter for the Weibull distribution. \param [in] bound Upper bound on values
* returned. \return A floating point random value.
* and upper bound.
* \param [in] scale Scale parameter for the Weibull distribution.
* \param [in] shape Shape parameter for the Weibull distribution.
* \param [in] bound Upper bound on values returned.
* \return A floating point random value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -891,9 +899,11 @@ class WeibullRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a Weibull distribution with the specified
* scale, shape, and upper bound. \param [in] scale Scale parameter for the Weibull
* distribution. \param [in] shape Shape parameter for the Weibull distribution. \param [in]
* bound Upper bound on values returned. \return A random unsigned integer value.
* scale, shape, and upper bound.
* \param [in] scale Scale parameter for the Weibull distribution.
* \param [in] shape Shape parameter for the Weibull distribution.
* \param [in] bound Upper bound on values returned.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -917,7 +927,8 @@ class WeibullRandomVariable : public RandomVariableStream
/**
* \brief Returns a random double from a Weibull distribution with the current scale, shape, and
* upper bound. \return A floating point random value.
* upper bound.
* \return A floating point random value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -946,7 +957,8 @@ class WeibullRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a Weibull distribution with the current scale,
* shape, and upper bound. \return A random unsigned integer value.
* shape, and upper bound.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -1051,8 +1063,10 @@ class NormalRandomVariable : public RandomVariableStream
/**
* \brief Returns a random double from a normal distribution with the specified mean, variance,
* and bound. \param [in] mean Mean value for the normal distribution. \param [in] variance
* Variance value for the normal distribution. \param [in] bound Bound on values returned.
* and bound.
* \param [in] mean Mean value for the normal distribution.
* \param [in] variance Variance value for the normal distribution.
* \param [in] bound Bound on values returned.
* \return A floating point random value.
*
* Note that antithetic values are being generated if m_isAntithetic
@@ -1091,9 +1105,11 @@ class NormalRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a normal distribution with the specified mean,
* variance, and bound. \param [in] mean Mean value for the normal distribution. \param [in]
* variance Variance value for the normal distribution. \param [in] bound Bound on values
* returned. \return A random unsigned integer value.
* variance, and bound.
* \param [in] mean Mean value for the normal distribution.
* \param [in] variance Variance value for the normal distribution.
* \param [in] bound Bound on values returned.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u1\f$ and \f$u2\f$ are uniform variables
@@ -1129,7 +1145,8 @@ class NormalRandomVariable : public RandomVariableStream
/**
* \brief Returns a random double from a normal distribution with the current mean, variance,
* and bound. \return A floating point random value.
* and bound.
* \return A floating point random value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u1\f$ and \f$u2\f$ are uniform variables
@@ -1170,7 +1187,8 @@ class NormalRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a normal distribution with the current mean,
* variance, and bound. \return A random unsigned integer value.
* variance, and bound.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u1\f$ and \f$u2\f$ are uniform variables
@@ -1296,8 +1314,10 @@ class LogNormalRandomVariable : public RandomVariableStream
/**
* \brief Returns a random double from a log-normal distribution with the specified mu and
* sigma. \param [in] mu Mu value for the log-normal distribution. \param [in] sigma Sigma value
* for the log-normal distribution. \return A floating point random value.
* sigma.
* \param [in] mu Mu value for the log-normal distribution.
* \param [in] sigma Sigma value for the log-normal distribution.
* \return A floating point random value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u1\f$ and \f$u2\f$ are uniform variables
@@ -1331,8 +1351,10 @@ class LogNormalRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a log-normal distribution with the specified mu
* and sigma. \param [in] mu Mu value for the log-normal distribution. \param [in] sigma Sigma
* value for the log-normal distribution. \return A random unsigned integer value.
* and sigma.
* \param [in] mu Mu value for the log-normal distribution.
* \param [in] sigma Sigma value for the log-normal distribution.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u1\f$ and \f$u2\f$ are uniform variables
@@ -1405,7 +1427,8 @@ class LogNormalRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a log-normal distribution with the current mu
* and sigma. \return A random unsigned integer value.
* and sigma.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u1\f$ and \f$u2\f$ are uniform variables
@@ -1521,8 +1544,10 @@ class GammaRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a gamma distribution with the specified alpha
* and beta. \param [in] alpha Alpha value for the gamma distribution. \param [in] beta Beta
* value for the gamma distribution. \return A random unsigned integer value.
* and beta.
* \param [in] alpha Alpha value for the gamma distribution.
* \param [in] beta Beta value for the gamma distribution.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u\f$ is a uniform variable over [0,1]
@@ -1553,7 +1578,8 @@ class GammaRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a gamma distribution with the current alpha and
* beta. \return A random unsigned integer value.
* beta.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u\f$ is a uniform variable over [0,1]
@@ -1567,8 +1593,10 @@ class GammaRandomVariable : public RandomVariableStream
private:
/**
* \brief Returns a random double from a normal distribution with the specified mean, variance,
* and bound. \param [in] mean Mean value for the normal distribution. \param [in] variance
* Variance value for the normal distribution. \param [in] bound Bound on values returned.
* and bound.
* \param [in] mean Mean value for the normal distribution.
* \param [in] variance Variance value for the normal distribution.
* \param [in] bound Bound on values returned.
* \return A floating point random value.
*
* Note that antithetic values are being generated if m_isAntithetic
@@ -1698,8 +1726,10 @@ class ErlangRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from an Erlang distribution with the specified k and
* lambda. \param [in] k K value for the Erlang distribution. \param [in] lambda Lambda value
* for the Erlang distribution. \return A random unsigned integer value.
* lambda.
* \param [in] k K value for the Erlang distribution.
* \param [in] lambda Lambda value for the Erlang distribution.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u\f$ is a uniform variable over [0,1]
@@ -1730,7 +1760,8 @@ class ErlangRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from an Erlang distribution with the current k and
* lambda. \return A random unsigned integer value.
* lambda.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u\f$ is a uniform variable over [0,1]
@@ -1744,8 +1775,10 @@ class ErlangRandomVariable : public RandomVariableStream
private:
/**
* \brief Returns a random double from an exponential distribution with the specified mean and
* upper bound. \param [in] mean Mean value of the random variables. \param [in] bound Upper
* bound on values returned. \return A floating point random value.
* upper bound.
* \param [in] mean Mean value of the random variables.
* \param [in] bound Upper bound on values returned.
* \return A floating point random value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -1838,8 +1871,11 @@ class TriangularRandomVariable : public RandomVariableStream
/**
* \brief Returns a random double from a triangular distribution with the specified mean, min,
* and max. \param [in] mean Mean value for the triangular distribution. \param [in] min Low end
* of the range. \param [in] max High end of the range. \return A floating point random value.
* and max.
* \param [in] mean Mean value for the triangular distribution.
* \param [in] min Low end of the range.
* \param [in] max High end of the range.
* \return A floating point random value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -1875,9 +1911,11 @@ class TriangularRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a triangular distribution with the specified
* mean, min, and max. \param [in] mean Mean value for the triangular distribution. \param [in]
* min Low end of the range. \param [in] max High end of the range. \return A random unsigned
* integer value.
* mean, min, and max.
* \param [in] mean Mean value for the triangular distribution.
* \param [in] min Low end of the range.
* \param [in] max High end of the range.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -1913,7 +1951,8 @@ class TriangularRandomVariable : public RandomVariableStream
/**
* \brief Returns a random double from a triangular distribution with the current mean, min, and
* max. \return A floating point random value.
* max.
* \return A floating point random value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -1954,7 +1993,8 @@ class TriangularRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a triangular distribution with the current
* mean, min, and max. \return A random unsigned integer value.
* mean, min, and max.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if
* m_isAntithetic is equal to true. If \f$u\f$ is a uniform variable
@@ -2102,8 +2142,10 @@ class ZipfRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a Zipf distribution with the specified n and
* alpha. \param [in] n N value for the Zipf distribution. \param [in] alpha Alpha value for the
* Zipf distribution. \return A random unsigned integer value.
* alpha.
* \param [in] n N value for the Zipf distribution.
* \param [in] alpha Alpha value for the Zipf distribution.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u\f$ is a uniform variable over [0,1]
@@ -2134,7 +2176,8 @@ class ZipfRandomVariable : public RandomVariableStream
/**
* \brief Returns a random unsigned integer from a Zipf distribution with the current n and
* alpha. \return A random unsigned integer value.
* alpha.
* \return A random unsigned integer value.
*
* Note that antithetic values are being generated if m_isAntithetic
* is equal to true. If \f$u\f$ is a uniform variable over [0,1]

4
src/core/model/scheduler.h
View File

@@ -157,8 +157,8 @@ class Scheduler : public Object
{
public:
/**
* Register this type.
* \return The object TypeId.
* Register this type.
* \return The object TypeId.
*/
static TypeId GetTypeId();

16
src/core/model/type-id.cc
View File

@@ -1220,10 +1220,10 @@ TypeId::SetUid(uint16_t uid)
}
/**
* \brief Insertion operator for TypeId
* \param [in] os the output stream
* \param [in] tid the TypeId
* \returns the updated output stream.
* \brief Insertion operator for TypeId
* \param [in] os the output stream
* \param [in] tid the TypeId
* \returns the updated output stream.
*/
std::ostream&
operator<<(std::ostream& os, TypeId tid)
@@ -1233,10 +1233,10 @@ operator<<(std::ostream& os, TypeId tid)
}
/**
* \brief Extraction operator for TypeId
* \param [in] is the input stream
* \param [out] tid the TypeId value
* \returns the updated input stream.
* \brief Extraction operator for TypeId
* \param [in] is the input stream
* \param [out] tid the TypeId value
* \returns the updated input stream.
*/
std::istream&
operator>>(std::istream& is, TypeId& tid)