Fix Doxygen formatting

This commit is contained in:
Eduardo Almeida
2024-08-20 14:44:36 +01:00
parent 4f8f110e7d
commit e8ed6a539c
33 changed files with 98 additions and 88 deletions

View File

@@ -125,7 +125,8 @@ experiment(bool enableCtsRts, std::string wifiManager)
cbrApps.Add(onOffHelper.Install(nodes.Get(0)));
// flow 2: node 2 -> node 1
/** \internal
/**
* \internal
* The slightly different start times and data rates are a workaround
* for \bugid{388} and \bugid{912}
*/
@@ -133,7 +134,8 @@ experiment(bool enableCtsRts, std::string wifiManager)
onOffHelper.SetAttribute("StartTime", TimeValue(Seconds(1.001)));
cbrApps.Add(onOffHelper.Install(nodes.Get(2)));
/** \internal
/**
* \internal
* We also use separate UDP applications that will send a single
* packet before the CBR flows start.
* This is a workaround for the lack of perfect ARP, see \bugid{187}

View File

@@ -672,7 +672,8 @@ class CommandLine
}; // class CommandLine
/** \ingroup commandline
/**
* \ingroup commandline
* \defgroup commandlinehelper Helpers to specialize UserItem
*/
/**

View File

@@ -492,7 +492,8 @@ void
LogSetTimePrinter(TimePrinter printer)
{
g_logTimePrinter = printer;
/** \internal
/**
* \internal
* This is the only place where we are more or less sure that all log variables
* are registered. See \bugid{1082} for details.
*/

View File

@@ -394,25 +394,25 @@ Ptr<const AttributeChecker> MakeVectorChecker();
// Document these by hand so they go in group attribute_Vector3D
/*!
\ingroup attribute_Vector3D
\fn ns3::Ptr<const ns3::AttributeAccessor> ns3::MakeVectorAccessor (T1 a1)
\copydoc ns3::MakeAccessorHelper(T1)
\see AttributeAccessor
/**
* \ingroup attribute_Vector3D
* \fn ns3::Ptr<const ns3::AttributeAccessor> ns3::MakeVectorAccessor (T1 a1)
* \copydoc ns3::MakeAccessorHelper(T1)
* \see AttributeAccessor
*/
/*!
\ingroup attribute_Vector3D
\fn ns3::Ptr<const ns3::AttributeAccessor> ns3::MakeVectorAccessor (T1 a1, T2 a2)
\copydoc ns3::MakeAccessorHelper(T1,T2)
\see AttributeAccessor
/**
* \ingroup attribute_Vector3D
* \fn ns3::Ptr<const ns3::AttributeAccessor> ns3::MakeVectorAccessor (T1 a1, T2 a2)
* \copydoc ns3::MakeAccessorHelper(T1,T2)
* \see AttributeAccessor
*/
/*!
\ingroup attribute_Vector3D
\fn ns3::Ptr<const ns3::AttributeChecker> ns3::MakeVectorChecker ()
\returns The AttributeChecker.
\see AttributeChecker
/**
* \ingroup attribute_Vector3D
* \fn ns3::Ptr<const ns3::AttributeChecker> ns3::MakeVectorChecker ()
* \returns The AttributeChecker.
* \see AttributeChecker
*/
#endif /* NS3_VECTOR_H */

View File

@@ -1,4 +1,3 @@
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2018 Lawrence Livermore National Laboratory
*

View File

@@ -1145,7 +1145,8 @@ class TcpSocketBase : public TcpSocket
*/
void DoRetransmit();
/** \brief Add options to TcpHeader
/**
* \brief Add options to TcpHeader
*
* Test each option, and if it is enabled on our side, add it
* to the header
@@ -1232,7 +1233,8 @@ class TcpSocketBase : public TcpSocket
*/
void AddOptionSack(TcpHeader& header);
/** \brief Process the timestamp option from other side
/**
* \brief Process the timestamp option from other side
*
* Get the timestamp and the echo, then save timestamp (which will
* be the echo value in our out-packets) and save the echoed timestamp,

View File

@@ -303,7 +303,8 @@ class TcpAdvertisedWindowTest : public TcpGeneralTest
Ptr<ErrorModel> CreateReceiverErrorModel() override;
private:
/** \brief Callback called for the update of the awnd
/**
* \brief Callback called for the update of the awnd
* \param oldAwnd Old advertised window
* \param newAwnd new value
*/
@@ -389,7 +390,8 @@ class TcpAdvWindowOnLossTest : public TcpGeneralTest
Ptr<ErrorModel> CreateReceiverErrorModel() override;
private:
/** \brief Callback called for the update of the awnd
/**
* \brief Callback called for the update of the awnd
* \param oldAwnd Old advertised window
* \param newAwnd new value
*/

View File

@@ -60,7 +60,8 @@ class TcpLedbatToNewReno : public TestCase
private:
void DoRun() override;
/** \brief Execute the test
/**
* \brief Execute the test
*/
void ExecuteTest();
@@ -160,7 +161,8 @@ class TcpLedbatIncrementTest : public TestCase
private:
void DoRun() override;
/** \brief Execute the test
/**
* \brief Execute the test
*/
void ExecuteTest();
@@ -261,7 +263,8 @@ class TcpLedbatDecrementTest : public TestCase
private:
void DoRun() override;
/** \brief Execute the test
/**
* \brief Execute the test
*/
void ExecuteTest();

View File

@@ -690,14 +690,14 @@ class LrWpanMac : public LrWpanMacBase
* Obtain the number of symbols in the packet which is currently being sent by the MAC layer.
*
* \return packet number of symbols
* */
*/
uint64_t GetTxPacketSymbols();
/**
* Check if the packet to transmit requires acknowledgment
*
* \return True if the Tx packet requires acknowledgment
* */
*/
bool IsTxAckReq();
/**

View File

@@ -318,7 +318,7 @@ class HtOperation : public WifiInformationElement
* Return MCS is supported.
*
* \param mcs MCS
*\
*
* \return the MCS is supported
*/
bool IsSupportedMcs(uint8_t mcs) const;