Fix Doxygen comment formatting and typos

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

View File

@@ -40,24 +40,24 @@ class FlowIdTag : public Tag
FlowIdTag();
/**
* Constructs a FlowIdTag with the given flow id
* Constructs a FlowIdTag with the given flow id
*
* \param flowId Id to use for the tag
* \param flowId Id to use for the tag
*/
FlowIdTag(uint32_t flowId);
/**
* Sets the flow id for the tag
* \param flowId Id to assign to the tag
* Sets the flow id for the tag
* \param flowId Id to assign to the tag
*/
void SetFlowId(uint32_t flowId);
/**
* Gets the flow id for the tag
* \returns current flow id for this tag
* Gets the flow id for the tag
* \returns current flow id for this tag
*/
uint32_t GetFlowId() const;
/**
* Uses a static variable to generate sequential flow id
* \returns flow id allocated
* Uses a static variable to generate sequential flow id
* \returns flow id allocated
*/
static uint32_t AllocateFlowId();

View File

@@ -551,8 +551,9 @@ class Ipv6Prefix
void SetPrefixLength(uint8_t prefixLength);
/**
* \brief Get the minimum prefix length, i.e., 128 - the length of the largest sequence trailing
* zeroes. \return minimum prefix length
* \brief Get the minimum prefix length, i.e., 128 - the length of the largest sequence
* trailing zeroes.
* \return minimum prefix length
*/
uint8_t GetMinimumPrefixLength() const;

View File

@@ -374,9 +374,9 @@ class LollipopCounter
* be on a circular region, and it is represented by
* the smallest circular distance between two numbers.
*
* Arithmetic operator.
* \param [in] val Counter to compute the difference against
* \return The result of the difference.
* Arithmetic operator.
* \param [in] val Counter to compute the difference against
* \return The result of the difference.
*/
T AbsoluteMagnitudeOfDifference(const LollipopCounter& val) const
{

View File

@@ -274,15 +274,16 @@ class PcapFile
/**
* \brief Compare two PCAP files packet-by-packet
*
* \param f1 First PCAP file name
* \param f2 Second PCAP file name
* \param sec [out] Time stamp of first different packet, seconds. Undefined if files don't
* differ.
* \param usec [out] Time stamp of first different packet, microseconds. Undefined if files
* don't differ.
* \param packets [out] Number of first different packet. Total number of parsed packets if
* files don't differ.
* \param snapLen Snap length (if used)
* \return true if files are different, false otherwise
*
* \param f1 First PCAP file name
* \param f2 Second PCAP file name
* \param sec [out] Time stamp of first different packet, seconds. Undefined if files
* doesn't differ. \param usec [out] Time stamp of first different packet, microseconds.
* Undefined if files doesn't differ. \param packets [out] Number of first different packet.
* Total number of parsed packets if files doesn't differ. \param snapLen Snap length (if
* used)
*/
static bool Diff(const std::string& f1,
const std::string& f2,