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

doc: use \pname{} instead of \p when referring to arguments.

Browse Source
This commit is contained in:
Peter D. Barnes, Jr
2020-04-10 16:19:35 -07:00
parent 5096cf389d
commit 2fb2ed1689
26 changed files with 123 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/core/examples/command-line-example.cc
View File

@@ -45,7 +45,7 @@ std::string g_cbArg = "cbArg default";
* Function to illustrate command line arguments handled by a
* Callback function.
*
* \param [in] val New value for \p g_cbArg.
* \param [in] val New value for \pname{g_cbArg}.
* \returns \c true.
*/
bool SetCbArg (std::string val)

2
src/core/examples/main-random-variable-stream.cc
View File

@@ -44,7 +44,7 @@ namespace {
* and `dround(0.257, 0.1) = 0.3`
* \param [in] number The number to round.
* \param [in] precision The least significant digit to keep in the rounding.
* \returns \p number rounded to \p precision.
* \returns \pname{number} rounded to \pname{precision}.
*/
double dround (double number, double precision)
{

34
src/core/model/attribute-accessor-helper.h
View File

@@ -42,7 +42,7 @@ namespace ns3 {
* \code
* typedef U (T::*getter)(void) const
* \endcode
* where \p T is the class and \p U is the type of
* where \pname{T} is the class and \pname{U} is the type of
* the return value.
*
* The set method should have one of these signatures:
@@ -50,16 +50,16 @@ namespace ns3 {
* typedef void (T::*setter)(U)
* typedef bool (T::*setter)(U)
* \endcode
* where \p T is the class and \p U is the type of the value to set
* where \pname{T} is the class and \pname{U} is the type of the value to set
* the attribute to, which should be compatible with the
* specific AttributeValue type \p V which holds the value
* specific AttributeValue type \pname{V} which holds the value
* (or the type implied by the name \c Make<V>Accessor of this function.)
* In the case of a \p setter returning \p bool, the return value
* In the case of a \pname{setter} returning \pname{bool,} the return value
* should be \c true if the value could be set successfully.
*
* \tparam V \explicit (If present) The specific AttributeValue type
* to use to represent the Attribute. (If not present,
* the type \p V is implicit in the name of this function,
* the type \pname{V} is implicit in the name of this function,
* as "Make<V>Accessor"
* \tparam T1 \deduced The type of the class data member,
* or the type of the class get functor or set method.
@@ -83,7 +83,7 @@ MakeAccessorHelper (T1 a1);
* \code
* typedef U (T::*getter)(void) const
* \endcode
* where \p T is the class and \p U is the type of
* where \pname{T} is the class and \pname{U} is the type of
* the return value.
*
* The set method should have one of these signatures:
@@ -91,18 +91,18 @@ MakeAccessorHelper (T1 a1);
* typedef void (T::*setter)(U)
* typedef bool (T::*setter)(U)
* \endcode
* where \p T is the class and \p U is the type of the value to set
* where \pname{T} is the class and \pname{U} is the type of the value to set
* the attribute to, which should be compatible with the
* specific AttributeValue type \p V which holds the value
* specific AttributeValue type \pname{V} which holds the value
* (or the type implied by the name \c Make<V>Accessor of this function.)
* In the case of a \p setter returning \p bool, the return value
* In the case of a \pname{setter} returning \pname{bool,} the return value
* should be true if the value could be set successfully.
*
* In practice the setter and getter arguments can appear in either order,
* but setter first is preferred.
*
* \tparam V \explicit (If present) The specific AttributeValue type to use to represent
* the Attribute. (If not present, the type \p V is implicit
* the Attribute. (If not present, the type \pname{V} is implicit
* in the name of this function as "Make<V>Accessor"
* \tparam T1 \deduced The type of the class data member,
* or the type of the class get functor or set method.
@@ -134,7 +134,7 @@ namespace ns3 {
/**
* \ingroup attributeimpl
*
* The non-const and non-reference type equivalent to \p T.
* The non-const and non-reference type equivalent to \pname{T}.
*
* \tparam T \explicit The original (possibly qualified) type.
*/
@@ -172,8 +172,8 @@ public:
*
* Forwards to DoSet method.
*
* \param [in] object Generic object pointer, to upcast to \p T.
* \param [in] val Generic AttributeValue, to upcast to \p U.
* \param [in] object Generic object pointer, to upcast to \pname{T}.
* \param [in] val Generic AttributeValue, to upcast to \pname{U}.
* \returns true if the member was set successfully.
*/
virtual bool Set (ObjectBase * object, const AttributeValue & val) const
@@ -199,8 +199,8 @@ public:
*
* Forwards to DoGet method.
*
* \param [out] object Generic object pointer, to upcast to \p T.
* \param [out] val Generic AttributeValue, to upcast to \p U.
* \param [out] object Generic object pointer, to upcast to \pname{T}.
* \param [out] val Generic AttributeValue, to upcast to \pname{U}.
* \returns true if the member value could be retrieved successfully
*/
virtual bool Get (const ObjectBase * object, AttributeValue &val) const
@@ -426,7 +426,7 @@ DoMakeAccessorHelperOne (void (T::*setter)(U))
* \ingroup attributeimpl
*
* MakeAccessorHelper implementation with a class get functor method
* and a class set method returning \p void.
* and a class set method returning \pname{void}.
*
* The two versions of this function differ only in argument order.
*
@@ -514,7 +514,7 @@ DoMakeAccessorHelperTwo (V (T::*getter)(void) const,
* \ingroup attributeimpl
*
* MakeAccessorHelper implementation with a class get functor method
* and a class set method returning \p bool.
* and a class set method returning \pname{bool}.
*
* The two versions of this function differ only in argument order.
*

62
src/core/model/attribute-helper.h
View File

@@ -87,9 +87,9 @@ namespace ns3 {
*
* \tparam T \explicit The specific AttributeValue type used to represent
* the Attribute.
* \tparam BASE \explicit The AttributeChecker type corresponding to \p T.
* \tparam BASE \explicit The AttributeChecker type corresponding to \pname{T}.
* \param [in] name The name of the AttributeValue type, essentially the
* string form of \p T.
* string form of \pname{T}.
* \param [in] underlying Underlying type name.
* \return Ptr to AttributeChecker.
*/
@@ -148,7 +148,7 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
* \ingroup attributehelper
*
* Define the attribute accessor functions \c MakeTypeAccessor
* for class \p type.
* for class \pname{type}.
*
* \param [in] type The name of the class
*
@@ -173,8 +173,8 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
/**
* \ingroup attributehelper
*
* Declare the attribute value class \p nameValue
* for underlying class \p type.
* Declare the attribute value class \pname{nameValue}
* for underlying class \pname{type}.
*
* \param [in] type The underlying type name token
* \param [in] name The token to use in defining the accessor name.
@@ -214,8 +214,8 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
/**
* \ingroup attributehelper
*
* Declare the attribute value class \p nameValue
* for the class \p name
* Declare the attribute value class \pname{nameValue}
* for the class \pname{name}
*
* \param [in] name The name of the class.
*
@@ -229,7 +229,7 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
/**
* \ingroup attributehelper
*
* Define the conversion operators class \p type and
* Define the conversion operators class \pname{type} and
* Attribute instances.
*
* \param [in] type The name of the class
@@ -246,15 +246,15 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
/**
* \ingroup attributehelper
*
* Declare the AttributeChecker class \p typeChecker
* and the \c MaketypeChecker function for class \p type.
* Declare the AttributeChecker class \pname{typeChecker}
* and the \c MaketypeChecker function for class \pname{type}.
*
* \param [in] type The name of the class
*
* This macro declares the \p typeChecker class and the associated
* This macro declares the \pname{typeChecker} class and the associated
* \c MaketypeChecker function.
*
* (Note that the \p typeChecker class needs no implementation
* (Note that the \pname{typeChecker} class needs no implementation
* since it just inherits all its implementation from AttributeChecker.)
*
* Typically invoked in the class header file.
@@ -268,15 +268,15 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
* \ingroup attributehelper
*
* Define the class methods belonging to
* the attribute value class \p nameValue
* of the underlying class \p type.
* the attribute value class \pname{nameValue}
* of the underlying class \pname{type}.
*
* \param [in] type The underlying type name
* \param [in] name The token to use in defining the accessor name.
*
* This macro implements the \p typeValue class methods
* (including the \p typeValue::SerializeToString
* and \p typeValue::DeserializeFromString methods).
* This macro implements the \pname{typeValue} class methods
* (including the \pname{typeValue}%::%SerializeToString
* and \pname{typeValue}%::%DeserializeFromString methods).
*
* Typically invoked in the source file
*/
@@ -316,13 +316,13 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
* \ingroup attributehelper
*
* Define the class methods belonging to
* attribute value class \p typeValue for class \p type.
* attribute value class \pname{typeValue} for class \pname{type}.
*
* \param [in] type The name of the class.
*
* This macro implements the \p typeValue class methods
* (including the \p typeValue::SerializeToString
* and \p typeValue::DeserializeFromString methods).
* This macro implements the \pname{typeValue} class methods
* (including the \pname{typeValue}%::%SerializeToString
* and \pname{typeValue}%::%DeserializeFromString methods).
*
* Typically invoked in the source file.
*/
@@ -333,7 +333,7 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
/**
* \ingroup attributehelper
*
* Define the \c MaketypeChecker function for class \p type.
* Define the \c MaketypeChecker function for class \pname{type}.
*
* \param [in] type The name of the class
*
@@ -350,13 +350,13 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
/**
* \ingroup attributehelper
*
* Define the \c MaketypeChecker function for class \p type.
* Define the \c MaketypeChecker function for class \pname{type}.
*
* \param [in] type The name of the class.
* \param [in] name The string name of the underlying type.
*
* This macro implements the \c MaketypeChecker function
* for class \p type.
* for class \pname{type}.
*
* Typically invoked in the source file..
*/
@@ -369,20 +369,20 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
/**
* \ingroup attributehelper
*
* Declare the attribute value, accessor and checkers for class \p type
* Declare the attribute value, accessor and checkers for class \pname{type}
*
* \param [in] type The name of the class
*
* This macro declares:
*
* - The attribute value class \p typeValue,
* - The attribute value class \pname{typeValue},
*
* - The attribute accessor functions \c MaketypeAccessor,
*
* - The AttributeChecker class \p typeChecker
* - The AttributeChecker class \pname{typeChecker},
* and the \c MaketypeChecker function,
*
* for class \p type.
* for class \pname{type}.
*
* This macro should be invoked outside of the class
* declaration in its public header.
@@ -395,17 +395,17 @@ MakeSimpleAttributeChecker (std::string name, std::string underlying)
/**
* \ingroup attributehelper
*
* Define the attribute value, accessor and checkers for class \p type
* Define the attribute value, accessor and checkers for class \pname{type}
*
* \param [in] type The name of the class
*
* This macro implements
*
* - The \p typeValue class methods,
* - The \pname{typeValue} class methods,
*
* - The \c MaketypeChecker function,
*
* for class \p type.
* for class \pname{type}.
*
* This macro should be invoked from the class implementation file.
*/

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

@@ -165,7 +165,7 @@ protected:
* Helper to get the C++ typeid as a string.
*
* \tparam T The type of the argument.
* \returns The result of applying typeid to the template type \p T.
* \returns The result of applying typeid to the template type \pname{T}.
*/
template <typename T>
static std::string GetCppTypeid (void)
@@ -1523,7 +1523,7 @@ public:
* Adopt the other's implementation, if type compatible
*
* \param [in] other Callback
* \returns \c true if \p other was type-compatible and could be adopted.
* \returns \c true if \pname{other} was type-compatible and could be adopted.
*/
bool Assign (const CallbackBase &other)
{

2
src/core/model/command-line.h
View File

@@ -473,7 +473,7 @@ private:
* Callback function to handle attributes.
*
* \param [in] name The full name of the Attribute.
* \param [in] value The value to assign to \p name.
* \param [in] value The value to assign to \pname{name}.
* \return \c true if the value was set successfully, false otherwise.
*/
static bool HandleAttribute (const std::string name, const std::string value);

4
src/core/model/config.cc
View File

@@ -612,9 +612,9 @@ private:
/**
* Break a Config path into the leading path and the last leaf token.
* \param [in] path The Config path.
* \param [in,out] root The leading part of the \p path,
* \param [in,out] root The leading part of the \pname{path},
* up to the final slash.
* \param [in,out] leaf The trailing part of the \p path.
* \param [in,out] leaf The trailing part of the \pname{path}.
*/
void ParsePath (std::string path, std::string *root, std::string *leaf) const;

6
src/core/model/event-id.h
View File

@@ -103,21 +103,21 @@ public:
* Test if two EventId's are equal.
* \param [in] a The first EventId.
* \param [in] b The second EventId.
* \return \c true if the \p a and \p b represent the same event.
* \return \c true if the \pname{a} and \pname{b} represent the same event.
*/
friend bool operator == (const EventId &a, const EventId &b);
/**
* Test if two EventId's are not equal.
* \param [in] a The first EventId.
* \param [in] b The second EventId.
* \return \c true if the \p a and \p b are not the same event.
* \return \c true if the \pname{a} and \pname{b} are not the same event.
*/
friend bool operator != (const EventId &a, const EventId &b);
/**
* Less than operator for two EventId's, based on time stamps.
* \param [in] a The first EventId.
* \param [in] b The second EventId.
* \return \c true if \p a occurs before \p b.
* \return \c true if \pname{a} occurs before \pname{b}.
*/
friend bool operator < (const EventId &a, const EventId &b);

6
src/core/model/heap-scheduler.h
View File

@@ -79,14 +79,14 @@ private:
* Get the parent index of a given entry.
*
* \param [in] id The child index.
* \return The index of the parent of \p id.
* \return The index of the parent of \pname{id}.
*/
inline std::size_t Parent (std::size_t id) const;
/**
* Get the next sibling of a given entry.
*
* \param [in] id The starting index.
* \returns The next sibling of \p id.
* \returns The next sibling of \pname{id}.
*/
std::size_t Sibling (std::size_t id) const;
/**
@@ -118,7 +118,7 @@ private:
* Test if an index is the root.
*
* \param [in] id The index to test.
* \returns \c true if the \p id is the root.
* \returns \c true if the \pname{id} is the root.
*/
inline bool IsRoot (std::size_t id) const;
/**

2
src/core/model/int64x64.h
View File

@@ -179,7 +179,7 @@ std::istream &operator >> (std::istream &is, int64x64_t &value);
* \ingroup highprec
* Absolute value.
* \param [in] value The value to operate on.
* \return The absolute value of \p value.
* \return The absolute value of \pname{value}.
*/
inline int64x64_t Abs (const int64x64_t &value)
{

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

@@ -310,7 +310,7 @@ public:
return m_data > 0;
}
/**
* Compare \p this to another Time
* Compare \pname{this} to another Time
*
* \param [in] o The other Time
* \return -1,0,+1 if `this < o`, `this == o`, or `this > o`
@@ -421,7 +421,7 @@ public:
* Create a Time in the current unit.
*
* \param [in] value The value of the new Time.
* \return A Time with \p value in the current time unit.
* \return A Time with \pname{value} in the current time unit.
*/
inline static Time From (const int64x64_t & value)
{
@@ -434,11 +434,11 @@ public:
* @{
*/
/**
* Create a Time equal to \p 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 \p value
* \return The Time representing \p value 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)
{
@@ -486,7 +486,7 @@ public:
* Get the Time value expressed in a particular unit.
*
* \param [in] unit The desired unit
* \return The Time expressed in \p unit
* \return The Time expressed in \pname{unit}
*/
inline int64_t ToInteger (enum Unit unit) const
{
@@ -580,10 +580,10 @@ private:
return &resolution;
}
/**
* Get the Information record for \p timeUnit for the current Resolution
* Get the Information record for \pname{timeUnit} for the current Resolution
*
* \param [in] timeUnit The Unit to get Information for
* \return The Information for \p timeUnit
* \return The Information for \pname{timeUnit}
*/
static inline struct Information * PeekInformation (enum Unit timeUnit)
{

6
src/core/model/object-base.h
View File

@@ -268,13 +268,13 @@ protected:
private:
/**
* Attempt to set the value referenced by the accessor \p spec
* to a valid value according to the \c checker, based on \p value.
* Attempt to set the value referenced by the accessor \pname{spec}
* to a valid value according to the \c checker, based on \pname{value}.
*
* \param [in] spec The accessor for the storage location.
* \param [in] checker The checker to use in validating the value.
* \param [in] value The value to attempt to store.
* \returns \c true if the \c value could be validated by the \p checker
* \returns \c true if the \c value could be validated by the \pname{checker}
* and written to the storage location.
*/
bool DoSet (Ptr<const AttributeAccessor> spec,

4
src/core/model/rng-stream.h
View File

@@ -73,10 +73,10 @@ public:
private:
/**
* Advance \p state of the RNG by leaps and bounds.
* Advance \pname{state} of the RNG by leaps and bounds.
*
* \param [in] nth The stream or substream index.
* \param [in] by The log2 base of \p nth.
* \param [in] by The log2 base of \pname{nth}.
* \param [in] state The state vector to advance.
*/
void AdvanceNthBy (uint64_t nth, int by, double state[6]);

2
src/core/model/simple-ref-count.h
View File

@@ -89,7 +89,7 @@ public:
/**
* Assignment operator
* \param [in] o The object to copy
* \returns The copy of \p o
* \returns The copy of \pname{o}
*/
SimpleRefCount &operator = (const SimpleRefCount &o)
{

2
src/core/model/test.cc
View File

@@ -177,7 +177,7 @@ private:
/**
* Check if this is the root of the source tree.
* \param [in] path The path to test.
* \returns \c true if \p path is the root.
* \returns \c true if \pname{path} is the root.
*/
bool IsTopLevelSourceDir (std::string path) const;
/**

6
src/core/model/test.h
View File

@@ -1240,7 +1240,7 @@ protected:
* \param [in] limit Expected value of the test.
* \param [in] message Message indicating the type of failure.
* \param [in] file The file where the test failed.
* \param [in] line The line number in \p file where the test failed.
* \param [in] line The line number in \pname{file} where the test failed.
*/
void ReportTestFailure (std::string cond, std::string actual,
std::string limit, std::string message,
@@ -1263,7 +1263,7 @@ protected:
* The data directory is configured by SetDataDirectory().
*
* \param [in] filename The bare (no path) file name
* \return The full path to \p filename in the data directory
* \return The full path to \pname{filename} in the data directory
*/
std::string CreateDataDirFilename (std::string filename);
/**
@@ -1273,7 +1273,7 @@ protected:
* the data directory instead.
*
* \param [in] filename The bare (no path) file name
* \return The full path to \p filename in the temporary directory.
* \return The full path to \pname{filename} in the temporary directory.
*/
std::string CreateTempDirFilename (std::string filename);
/**@}*/

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

@@ -116,13 +116,13 @@ public:
/**
* Get a type id by name.
* \param [in] name The type id to find.
* \returns The type id. A type id of 0 means \p name wasn't found.
* \returns The type id. A type id of 0 means \pname{name} wasn't found.
*/
uint16_t GetUid (std::string name) const;
/**
* Get a type id by hash value.
* \param [in] hash The type id to find.
* \returns The type id. A type id of 0 means \p hash wasn't found.
* \returns The type id. A type id of 0 means \pname{hash} wasn't found.
*/
uint16_t GetUid (TypeId::hash_t hash) const;
/**
@@ -226,7 +226,7 @@ public:
* Get Attribute information by index.
* \param [in] uid The id.
* \param [in] i Index into attribute array
* \returns The information associated to attribute whose index is \p i.
* \returns The information associated to attribute whose index is \pname{i}.
*/
struct TypeId::AttributeInformation GetAttribute (uint16_t uid, std::size_t i) const;
/**
@@ -276,20 +276,20 @@ private:
* Check if a type id has a given TraceSource.
* \param [in] uid The id.
* \param [in] name The TraceSource name.
* \returns \c true if \p uid has the TraceSource \p name.
* \returns \c true if \pname{uid} has the TraceSource \pname{name}.
*/
bool HasTraceSource (uint16_t uid, std::string name);
/**
* Check if a type id has a given Attribute.
* \param [in] uid The id.
* \param [in] name The Attribute name.
* \returns \c true if \p uid has the Attribute \p name.
* \returns \c true if \pname{uid} has the Attribute \pname{name}.
*/
bool HasAttribute (uint16_t uid, std::string name);
/**
* Hashing function.
* \param [in] name The type id name.
* \returns The hashed value of \p name.
* \returns The hashed value of \pname{name}.
*/
static TypeId::hash_t Hasher (const std::string name);

4
src/core/model/type-id.h
View File

@@ -255,14 +255,14 @@ public:
* Get Attribute information by index.
*
* \param [in] i Index into attribute array
* \returns The information associated to attribute whose index is \p i.
* \returns The information associated to attribute whose index is \pname{i}.
*/
struct TypeId::AttributeInformation GetAttribute (std::size_t i) const;
/**
* Get the Attribute name by index.
*
* \param [in] i Index into attribute array
* \returns The full name associated to the attribute whose index is \p i.
* \returns The full name associated to the attribute whose index is \pname{i}.
*/
std::string GetAttributeFullName (std::size_t i) const;

12
src/core/model/unix-fd-reader.h
View File

@@ -42,7 +42,7 @@ namespace ns3 {
* This class can be used to start a system thread that reads from a
* given file descriptor and invokes a given callback when data is
* received. This class handles thread management automatically but
* the \p DoRead() method must be implemented by a subclass.
* the \pname{DoRead()} method must be implemented by a subclass.
*/
class FdReader : public SimpleRefCount<FdReader>
{
@@ -95,12 +95,12 @@ protected:
/**
* \brief The read implementation.
*
* The value of \p m_len returned controls further processing. The
* callback function is only invoked when \p m_len is positive; any
* data read is not processed when \p m_len is negative; reading
* stops when \p m_len is zero.
* The value of \pname{m_len} returned controls further processing. The
* callback function is only invoked when \pname{m_len} is positive; any
* data read is not processed when \pname{m_len} is negative; reading
* stops when \pname{m_len} is zero.
*
* The management of memory associated with \p m_buf must be
* The management of memory associated with \pname{m_buf} must be
* compatible with the read callback.
*
* \return A structure representing what was read.

36
src/core/model/vector.h
View File

@@ -70,7 +70,7 @@ public:
* \brief Calculate the Cartesian distance between two points.
* \param [in] a One point
* \param [in] b Another point
* \returns The distance between \p a and \p b.
* \returns The distance between \pname{a} and \pname{b}.
*/
friend double CalculateDistance (const Vector3D &a, const Vector3D &b);
@@ -99,7 +99,7 @@ public:
* Less than comparison operator
* \param [in] a lhs vector
* \param [in] b rhs vector
* \returns \c true if \p a is less than \p b
* \returns \c true if \pname{a} is less than \pname{b}
*/
friend bool operator < (const Vector3D &a, const Vector3D &b);
@@ -107,7 +107,7 @@ public:
* Less than or equal to comparison operator
* \param [in] a lhs vector
* \param [in] b rhs vector
* \returns \c true if \p a is less than or equal to \p b.
* \returns \c true if \pname{a} is less than or equal to \pname{b}.
*/
friend bool operator <= (const Vector3D &a, const Vector3D &b);
@@ -115,7 +115,7 @@ public:
* Greater than comparison operator
* \param [in] a lhs vector
* \param [in] b rhs vector
* \returns \c true if \p a is greater than \p b.
* \returns \c true if \pname{a} is greater than \pname{b}.
*/
friend bool operator > (const Vector3D &a, const Vector3D &b);
@@ -123,7 +123,7 @@ public:
* Greater than or equal to comparison operator
* \param [in] a lhs vector
* \param [in] b rhs vector
* \returns \c true if \p a is greater than or equal to \p b.
* \returns \c true if \pname{a} is greater than or equal to \pname{b}.
*/
friend bool operator >= (const Vector3D &a, const Vector3D &b);
@@ -131,7 +131,7 @@ public:
* Equality operator.
* \param [in] a lhs vector.
* \param [in] b rhs vector.
* \returns \c true if \p a is equal to \p b.
* \returns \c true if \pname{a} is equal to \pname{b}.
*/
friend bool operator == (const Vector3D &a, const Vector3D &b);
@@ -139,7 +139,7 @@ public:
* Inequality operator.
* \param [in] a lhs vector.
* \param [in] b rhs vector.
* \returns \c true if \p a is not equal to \p b.
* \returns \c true if \pname{a} is not equal to \pname{b}.
*/
friend bool operator != (const Vector3D &a, const Vector3D &b);
@@ -147,7 +147,7 @@ public:
* Addition operator.
* \param [in] a lhs vector.
* \param [in] b rhs vector.
* \returns The vector sum of \p a and \p b.
* \returns The vector sum of \pname{a} and \pname{b}.
*/
friend Vector3D operator + (const Vector3D &a, const Vector3D &b);
@@ -155,7 +155,7 @@ public:
* Subtraction operator.
* \param [in] a lhs vector.
* \param [in] b rhs vector.
* \returns The vector difference of \p a and \p b.
* \returns The vector difference of \pname{a} and \pname{b}.
*/
friend Vector3D operator - (const Vector3D &a, const Vector3D &b);
};
@@ -188,7 +188,7 @@ public:
* \brief Calculate the Cartesian distance between two points.
* \param [in] a One point
* \param [in] b Another point
* \returns The distance between \p a and \p b.
* \returns The distance between \pname{a} and \pname{b}.
*/
friend double CalculateDistance (const Vector2D &a, const Vector2D &b);
@@ -217,7 +217,7 @@ public:
* Less than comparison operator
* \param [in] a lhs vector
* \param [in] b rhs vector
* \returns \c true if \p a is less than \p b
* \returns \c true if \pname{a} is less than \pname{b}
*/
friend bool operator < (const Vector2D &a, const Vector2D &b);
@@ -225,7 +225,7 @@ public:
* Less than or equal to comparison operator
* \param [in] a lhs vector
* \param [in] b rhs vector
* \returns \c true if \p a is less than or equal to \p b.
* \returns \c true if \pname{a} is less than or equal to \pname{b}.
*/
friend bool operator <= (const Vector2D &a, const Vector2D &b);
@@ -233,7 +233,7 @@ public:
* Greater than comparison operator
* \param [in] a lhs vector
* \param [in] b rhs vector
* \returns \c true if \p a is greater than \p b.
* \returns \c true if \pname{a} is greater than \pname{b}.
*/
friend bool operator > (const Vector2D &a, const Vector2D &b);
@@ -241,7 +241,7 @@ public:
* Greater than or equal to comparison operator
* \param [in] a lhs vector
* \param [in] b rhs vector
* \returns \c true if \p a is greater than or equal to \p b.
* \returns \c true if \pname{a} is greater than or equal to \pname{b}.
*/
friend bool operator >= (const Vector2D &a, const Vector2D &b);
@@ -249,7 +249,7 @@ public:
* Equality operator.
* \param [in] a lhs vector.
* \param [in] b rhs vector.
* \returns \c true if \p a is equal to \p b.
* \returns \c true if \pname{a} is equal to \pname{b}.
*/
friend bool operator == (const Vector2D &a, const Vector2D &b);
@@ -257,7 +257,7 @@ public:
* Inequality operator.
* \param [in] a lhs vector.
* \param [in] b rhs vector.
* \returns \c true if \p a is not equal to \p b.
* \returns \c true if \pname{a} is not equal to \pname{b}.
*/
friend bool operator != (const Vector2D &a, const Vector2D &b);
@@ -265,7 +265,7 @@ public:
* Addition operator.
* \param [in] a lhs vector.
* \param [in] b rhs vector.
* \returns The vector sum of \p a and \p b.
* \returns The vector sum of \pname{a} and \pname{b}.
*/
friend Vector2D operator + (const Vector2D &a, const Vector2D &b);
@@ -273,7 +273,7 @@ public:
* Subtraction operator.
* \param [in] a lhs vector.
* \param [in] b rhs vector.
* \returns The vector difference of \p a and \p b.
* \returns The vector difference of \pname{a} and \pname{b}.
*/
friend Vector2D operator - (const Vector2D &a, const Vector2D &b);
};

2
src/core/test/ptr-test-suite.cc
View File

@@ -103,7 +103,7 @@ public:
private:
virtual void DoRun (void);
/**
* Test that \p p is a valid object, by calling a member function.
* Test that \pname{p} is a valid object, by calling a member function.
* \param [in] p The object pointer to test.
* \returns The object pointer.
*/

2
src/internet/model/ipv4-l3-protocol.h
View File

@@ -605,7 +605,7 @@ private:
/**
* Registers duplicate entry, return false if new
* \param [in] p Possibly duplicate packet.
* \param [in] header Packet \p p header.
* \param [in] header Packet \pname{p} header.
* \return True if this packet is a duplicate
*/
bool UpdateDuplicate (Ptr<const Packet> p, const Ipv4Header &header);

6
src/internet/model/tcp-congestion-ops.h
View File

@@ -104,7 +104,7 @@ public:
/**
* \brief Congestion avoidance algorithm implementation
*
* Mimic the function \p cong_avoid in Linux. New segments have been ACKed,
* Mimic the function \pname{cong_avoid} in Linux. New segments have been ACKed,
* and the congestion control duty is to update the window.
*
* The function is allowed to change directly cWnd and/or ssThresh.
@@ -132,7 +132,7 @@ public:
/**
* \brief Trigger events/calculations specific to a congestion state
*
* This function mimics the notification function \p set_state in Linux.
* This function mimics the notification function \pname{set_state} in Linux.
* The function does not change the congestion state in the tcb; it notifies
* the congestion control algorithm that this state is about to be changed.
* The tcb->m_congState variable must be separately set; for example:
@@ -151,7 +151,7 @@ public:
/**
* \brief Trigger events/calculations on occurrence of congestion window event
*
* This function mimics the function \p cwnd_event in Linux.
* This function mimics the function \pname{cwnd_event} in Linux.
* The function is called in case of congestion window events.
*
* \param tcb internal congestion state

2
src/wifi/model/block-ack-manager.h
View File

@@ -372,7 +372,7 @@ public:
/**
* TracedCallback signature for state changes.
*
* \param [in] now Time when the \p state changed.
* \param [in] now Time when the \pname{state} changed.
* \param [in] recipient MAC address of the recipient.
* \param [in] tid the TID.
* \param [in] state The state.

4
src/wifi/model/wifi-phy-state-helper.h
View File

@@ -232,9 +232,9 @@ public:
/**
* TracedCallback signature for state changes.
*
* \param [in] start Time when the \p state started.
* \param [in] start Time when the \pname{state} started.
* \param [in] duration Amount of time we've been in (or will be in)
* the \p state.
* the \pname{state}.
* \param [in] state The state.
*/
typedef void (* StateTracedCallback)(Time start, Time duration, WifiPhyState state);

6
utils/print-introspected-doxygen.cc
View File

@@ -1287,7 +1287,7 @@ PrintAttributeValueSection (std::ostream & os,
/**
* Print the AttributeValue documentation for a class.
*
* This will print documentation for the \p AttributeValue class and methods.
* This will print documentation for the \pname{AttributeValue} class and methods.
*
* \param [in,out] os The output stream.
* \param [in] name The token to use in defining the accessor name.
@@ -1376,7 +1376,7 @@ PrintAttributeValueWithName (std::ostream & os,
/**
* Print the AttributeValue MakeAccessor documentation for a class.
*
* This will print documentation for the \p Make<name>Accessor functions.
* This will print documentation for the \pname{Make<name>Accessor} functions.
*
* \param [in,out] os The output stream.
* \param [in] name The token to use in defining the accessor name.
@@ -1411,7 +1411,7 @@ PrintMakeAccessors (std::ostream & os, const std::string & name)
/**
* Print the AttributeValue MakeChecker documentation for a class.
*
* This will print documentation for the \p Make<name>Checker function.
* This will print documentation for the \pname{Make<name>Checker} function.
*
* \param [in,out] os The output stream.
* \param [in] name The token to use in defining the accessor name.