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

Fix typos

Browse Source
This commit is contained in:
Eduardo Almeida
2023-02-08 15:32:19 +00:00
parent 41a5908cb1
commit d3426db18d
23 changed files with 56 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/antenna/model/angles.h
View File

@@ -120,7 +120,7 @@ class Angles
/**
* This constructor allows to specify azimuth and inclination.
* Inclination must be in [0, M_PI], while azimuth is
* automatically notmalized in [-M_PI, M_PI)
* automatically normalized in [-M_PI, M_PI)
*
* \param azimuth the azimuth angle in radians
* \param inclination the inclination angle in radians
@@ -209,7 +209,7 @@ class Angles
*
* Note: while an arbitrary value for the azimuth angle is valid
* and can be wrapped in [-M_PI, M_PI), an inclination angle outside
* the [0, M_PI] range can be ambiguos and is thus not valid.
* the [0, M_PI] range can be ambiguous and is thus not valid.
*/
void NormalizeAngles();

6
src/antenna/model/three-gpp-antenna-model.h
View File

@@ -25,11 +25,9 @@ namespace ns3
{
/**
*
* \brief Antenna model based on a parabolic approximation of the main lobe radiation pattern.
*
* This class implements the parabolic model as described in 3GPP TR 38.901 v15.0.0
*
*/
class ThreeGppAntennaModel : public AntennaModel
{
@@ -65,8 +63,8 @@ class ThreeGppAntennaModel : public AntennaModel
double GetSlaV() const;
/**
* Get the naximum attenuation of the antenna element.
* \return the naximum attenuation in dB
* Get the maximum attenuation of the antenna element.
* \return the maximum attenuation in dB
*/
double GetMaxAttenuation() const;

2
src/aodv/model/aodv-id-cache.h
View File

@@ -79,7 +79,7 @@ class IdCache
/**
* Return lifetime for existing entries in cache
* \returns thhe lifetime
* \returns the lifetime
*/
Time GetLifeTime() const
{

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

@@ -398,7 +398,7 @@ class LogComponent
typedef std::map<std::string, LogComponent*> ComponentList;
/**
* Get the list of LogComponnents.
* Get the list of LogComponents.
*
* \internal
* This should really be considered an internal API.

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

@@ -30,7 +30,7 @@
* \file
* \ingroup object
* ns3::ObjectBase declaration and
* NS_OBJECT_ENSURE_REGISTERED() madro definition.
* NS_OBJECT_ENSURE_REGISTERED() macro definition.
*/
/**

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

@@ -225,7 +225,7 @@ namespace tests
* \brief Test that an actual and expected (limit) value are equal and
* report if not.
*
* Check to see if the expected (lmit) value is equal to the actual
* Check to see if the expected (limit) value is equal to the actual
* value found in a test case. If the two values are equal nothing
* happens, but if the comparison fails, an error is reported in a
* consistent way. EXPECT* macros do not return if an error is
@@ -1130,7 +1130,7 @@ class TestCase
bool IsStatusSuccess() const;
/**
* \brief Get the parent of this TestCsse.
* \brief Get the parent of this TestCase.
*
* \return A pointer to the parent of this test.
*/

2
src/dsdv/model/dsdv-rtable.h
View File

@@ -432,7 +432,7 @@ class RoutingTable
*/
bool ForceDeleteIpv4Event(Ipv4Address address);
/**
* Get the EcentId associated with that address.
* Get the EventId associated with that address.
* \param address destination address for which this event is running.
* \return EventId on finding out an event is associated else return NULL.
*/

2
src/internet/test/tcp-header-test.cc
View File

@@ -385,7 +385,7 @@ TcpHeaderWithRFC793OptionTestCase::DoTeardown()
/**
* \ingroup internet-test
*
* \brief TCP header Flags to Striing test.
* \brief TCP header Flags to String test.
*/
class TcpHeaderFlagsToString : public TestCase
{

20
src/lr-wpan/model/lr-wpan-mac-header.h
View File

@@ -186,13 +186,13 @@ class LrWpanMacHeader : public Header
*/
Mac64Address GetExtSrcAddr() const;
/**
* Get the Auxiliary Security Header - Security Control Octect
* \return the Auxiliary Security Header - Security Control Octect
* Get the Auxiliary Security Header - Security Control Octet
* \return the Auxiliary Security Header - Security Control Octet
*/
uint8_t GetSecControl() const;
/**
* Get the Auxiliary Security Header - Frame Counter Octects
* \return the Auxiliary Security Header - Frame Counter Octects
* Get the Auxiliary Security Header - Frame Counter Octets
* \return the Auxiliary Security Header - Frame Counter Octets
*/
uint32_t GetFrmCounter() const;
@@ -212,13 +212,13 @@ class LrWpanMacHeader : public Header
*/
uint8_t GetSecCtrlReserved() const;
/**
* Get the Auxiliary Security Header - Key Identifier - Key Source (2 Octects)
* \return the Auxiliary Security Header - Key Identifier - Key Source (2 Octects)
* Get the Auxiliary Security Header - Key Identifier - Key Source (2 Octets)
* \return the Auxiliary Security Header - Key Identifier - Key Source (2 Octets)
*/
uint32_t GetKeyIdSrc32() const;
/**
* Get the Auxiliary Security Header - Key Identifier - Key Source (4 Octects)
* \return the Auxiliary Security Header - Key Identifier - Key Source (4 Octects)
* Get the Auxiliary Security Header - Key Identifier - Key Source (4 Octets)
* \return the Auxiliary Security Header - Key Identifier - Key Source (4 Octets)
*/
uint64_t GetKeyIdSrc64() const;
/**
@@ -342,12 +342,12 @@ class LrWpanMacHeader : public Header
/* Auxiliary Security Header is only set if Sec Enable (SecU) field is set to 1 */
/**
* Set the auxiliary security header "Security Control" octet
* \param secLevel the "Security Control" octect
* \param secLevel the "Security Control" octet
*/
void SetSecControl(uint8_t secLevel);
/**
* Set the auxiliary security header "Frame Counter" octet
* \param frmCntr the "Frame Counter" octect
* \param frmCntr the "Frame Counter" octet
*/
void SetFrmCounter(uint32_t frmCntr);
/**

2
src/lte/model/ff-mac-common.h
View File

@@ -182,7 +182,7 @@ struct VendorSpecificValue : public SimpleRefCount<VendorSpecificValue>
};
/**
* \brief See section 4.3.3 vendorSpecifiListElement
* \brief See section 4.3.3 vendorSpecificListElement
* \struct VendorSpecificListElement_s
*/
struct VendorSpecificListElement_s

2
src/lte/model/lte-common.cc
View File

@@ -75,7 +75,7 @@ ImsiLcidPair_t::ImsiLcidPair_t(const uint64_t a, const uint8_t b)
}
/**
* Equaity operator
* Equality operator
*
* \param a lhs
* \param b rhs

2
src/lte/model/lte-spectrum-value-helper.cc
View File

@@ -33,7 +33,7 @@ namespace std
/**
* \brief Stream insertion operator.
*
* \note This function scope is stricly local, and can not be
* \note This function scope is strictly local, and can not be
* used in other source files.
*
* \param [in] os The reference to the output stream.

18
src/lte/test/lte-test-frequency-reuse.h
View File

@@ -75,12 +75,12 @@ class LteFrTestCase : public TestCase
/**
* DL data receive start function
* \param spectrumValue the DL data reeive spectrum value
* \param spectrumValue the DL data receive spectrum value
*/
void DlDataRxStart(Ptr<const SpectrumValue> spectrumValue);
/**
* UL data receive start function
* \param spectrumValue the UL data reeive spectrum value
* \param spectrumValue the UL data receive spectrum value
*/
void UlDataRxStart(Ptr<const SpectrumValue> spectrumValue);
@@ -120,7 +120,7 @@ class LteHardFrTestCase : public LteFrTestCase
* \param ulSubBandOffset UL subband offset
* \param ulSubBandwidth UL subbandwidth
* \param availableDlRb the available DL per RB
* \param availableUlRb the avaialbel UL per RB
* \param availableUlRb the available UL per RB
*/
LteHardFrTestCase(std::string name,
uint32_t userNum,
@@ -150,7 +150,7 @@ class LteHardFrTestCase : public LteFrTestCase
/**
* \ingroup lte-test
*
* \brief Test stric frequency reuse algorithm. Test fails if the muted frequencies
* \brief Test strict frequency reuse algorithm. Test fails if the muted frequencies
* are being used.
*/
class LteStrictFrTestCase : public LteFrTestCase
@@ -171,7 +171,7 @@ class LteStrictFrTestCase : public LteFrTestCase
* \param ulEdgeSubBandOffset UL subband offset
* \param ulEdgeSubBandwidth UL subbandwidth
* \param availableDlRb the available DL per RB
* \param availableUlRb the avaialbel UL per RB
* \param availableUlRb the available UL per RB
*/
LteStrictFrTestCase(std::string name,
uint32_t userNum,
@@ -205,7 +205,7 @@ class LteStrictFrTestCase : public LteFrTestCase
/**
* \ingroup lte-test
*
* \brief Test frequency reuse algorithm by teleporing UEs to different
* \brief Test frequency reuse algorithm by teleporting UEs to different
* parts of area and checking if the frequency is used according to the
* frequency pattern for different parts of area. Test fails if the muted
* frequencies for a given part of area are being used by UE.
@@ -224,12 +224,12 @@ class LteFrAreaTestCase : public TestCase
/**
* DL data receive start function
* \param spectrumValue the DL receive specturm value
* \param spectrumValue the DL receive spectrum value
*/
void DlDataRxStart(Ptr<const SpectrumValue> spectrumValue);
/**
* UL data receive start function
* \param spectrumValue the UL receive specturm value
* \param spectrumValue the UL receive spectrum value
*/
void UlDataRxStart(Ptr<const SpectrumValue> spectrumValue);
@@ -282,7 +282,7 @@ class LteFrAreaTestCase : public TestCase
uint16_t m_dlBandwidth; ///< the DL bandwidth
uint16_t m_ulBandwidth; ///< the UL bandwidth
Time m_teleportTime; ///< the telport time
Time m_teleportTime; ///< the teleport time
Ptr<MobilityModel> m_ueMobility; ///< the UE mobility model
double m_expectedDlPower; ///< the expected DL power

16
src/lte/test/test-lte-x2-handover-measures.cc
View File

@@ -135,7 +135,7 @@ class LteX2HandoverMeasuresTestCase : public TestCase
std::list<CheckPointEvent> m_checkPointEventList; ///< check point event list
std::string m_checkPointEventListName; ///< check point event list name
bool m_epc; ///< whether to use EPC
bool m_useUdp; ///< whether to use UDP traffic
bool m_useUdp; ///< whether to use UDP traffic
std::string m_schedulerType; ///< scheduler type
std::string m_handoverAlgorithmType; ///< handover algorithm type
bool m_admitHo; ///< whether to configure to admit handover
@@ -717,7 +717,7 @@ LteX2HandoverMeasuresTestCase::CheckStats(uint32_t ueIndex)
NS_LOG_LOGIC("expBytes " << expectedBytes << " dlRx " << dlRx << " ulRx " << ulRx);
// tolerance
// tolerance
if (it->dlSink)
{
NS_TEST_ASSERT_MSG_GT(dlRx,
@@ -776,8 +776,7 @@ LteX2HandoverMeasuresTestSuite::LteX2HandoverMeasuresTestSuite()
std::string ho = "ns3::A2A4RsrqHandoverAlgorithm";
for (useIdealRrc = 1; useIdealRrc >= 0; --useIdealRrc)
{
// nEnbs, nUes, nDBearers, celist, name, useUdp,
// sched, ho, admitHo, idealRrc
// nEnbs, nUes, nDBearers, celist, name, useUdp, sched, ho, admitHo, idealRrc
AddTestCase(new LteX2HandoverMeasuresTestCase(2,
1,
0,
@@ -882,8 +881,7 @@ LteX2HandoverMeasuresTestSuite::LteX2HandoverMeasuresTestSuite()
sched = "ns3::RrFfMacScheduler";
for (useIdealRrc = 1; useIdealRrc >= 0; --useIdealRrc)
{
// nEnbs, nUes, nDBearers, celist, name, useUdp,
// sched, admitHo, idealRrc
// nEnbs, nUes, nDBearers, celist, name, useUdp, sched, admitHo, idealRrc
AddTestCase(new LteX2HandoverMeasuresTestCase(2,
1,
0,
@@ -923,8 +921,7 @@ LteX2HandoverMeasuresTestSuite::LteX2HandoverMeasuresTestSuite()
sched = "ns3::PfFfMacScheduler";
for (useIdealRrc = 1; useIdealRrc >= 0; --useIdealRrc)
{
// nEnbs, nUes, nDBearers, celist, name, useUdp,
// sched, admitHo, idealRrc
// nEnbs, nUes, nDBearers, celist, name, useUdp, sched, admitHo, idealRrc
AddTestCase(new LteX2HandoverMeasuresTestCase(2,
1,
0,
@@ -963,8 +960,7 @@ LteX2HandoverMeasuresTestSuite::LteX2HandoverMeasuresTestSuite()
sched = "ns3::RrFfMacScheduler";
for (useIdealRrc = 1; useIdealRrc >= 0; --useIdealRrc)
{
// nEnbs, nUes, nDBearers, celist, name, useUdp,
// sched, admitHo, idealRrc
// nEnbs, nUes, nDBearers, celist, name, useUdp, sched, admitHo, idealRrc
AddTestCase(new LteX2HandoverMeasuresTestCase(2,
1,
0,

5
src/lte/test/test-lte-x2-handover.cc
View File

@@ -227,7 +227,7 @@ LteX2HandoverTestCase::DoRun()
uint32_t previousSeed = RngSeedManager::GetSeed();
uint64_t previousRun = RngSeedManager::GetRun();
Config::Reset();
// This test is sensitive to random variable stream assigments
// This test is sensitive to random variable stream assignments
RngSeedManager::SetSeed(1);
RngSeedManager::SetRun(3);
Config::SetDefault("ns3::UdpClient::Interval", TimeValue(m_udpClientInterval));
@@ -765,8 +765,7 @@ LteX2HandoverTestSuite::LteX2HandoverTestSuite()
{
for (int32_t useIdealRrc = 1; useIdealRrc >= 0; --useIdealRrc)
{
// nUes, nDBearers, helist, name, sched, admitHo,
// idealRrc
// nUes, nDBearers, helist, name, sched, admitHo, idealRrc
AddTestCase(
new LteX2HandoverTestCase(1, 0, hel0, hel0name, *schedIt, true, useIdealRrc),
TestCase::EXTENSIVE);

2
src/mpi/model/mpi-receiver.cc
View File

@@ -18,7 +18,7 @@
/**
* \file
* \ingroup mpi
* ns3::MpiReciver implementation,
* ns3::MpiReceiver implementation,
* provides an interface to aggregate to MPI-compatible NetDevices.
*/

13
src/netanim/model/animation-interface.h
View File

@@ -627,7 +627,7 @@ class AnimationInterface
bool m_enablePacketMetadata; ///< enable packet metadata
Time m_startTime; ///< start time
Time m_stopTime; ///< stop time
uint64_t m_maxPktsPerFile; ///< maximum pakets per file
uint64_t m_maxPktsPerFile; ///< maximum packets per file
std::string m_originalFileName; ///< original file name
Time m_routingStopTime; ///< routing stop time
std::string m_routingFileName; ///< routing file name
@@ -1048,7 +1048,7 @@ class AnimationInterface
* \param tx the transmit device
* \param rx the receive device
* \param txTime the transmit time
* \param rxTime the reeive time
* \param rxTime the receive time
*/
void DevTxTrace(std::string context,
Ptr<const Packet> p,
@@ -1501,7 +1501,6 @@ class AnimationInterface
* When Anim receives a Tx Notification we tag the packet with a unique global uint64_t identifier
* before recording Tx information
* When Anim receives Rx notifications the tag is used to retrieve Tx information recorded earlier
*
*/
class AnimByteTag : public Tag
@@ -1510,56 +1509,48 @@ class AnimByteTag : public Tag
/**
* \brief Get Type Id
* \returns Type Id
*
*/
static TypeId GetTypeId();
/**
* \brief Get Instance Type Id
* \returns Type Id
*
*/
TypeId GetInstanceTypeId() const override;
/**
* \brief Get Serialized Size
* \returns Serialized Size (i.e size of uint64_t)
*
*/
uint32_t GetSerializedSize() const override;
/**
* \brief Serialize function
* \param i Tag Buffer
*
*/
void Serialize(TagBuffer i) const override;
/**
* \brief Deserialize function
* \param i Tag Buffer
*
*/
void Deserialize(TagBuffer i) override;
/**
* \brief Print tag info
* \param os Reference of ostream object
*
*/
void Print(std::ostream& os) const override;
/**
* \brief Set global Uid in tag
* \param AnimUid global Uid
*
*/
void Set(uint64_t AnimUid);
/**
* \brief Get Uid in tag
* \returns Uid in tag
*
*/
uint64_t Get() const;

2
src/network/utils/mac8-address.h
View File

@@ -159,7 +159,7 @@ class Mac8Address
bool operator<(const Mac8Address& a, const Mac8Address& b);
/**
* Address comparison, equalit.
* Address comparison, equality.
*
* \param a First address to compare.
* \param b Second address to compare.

2
src/traffic-control/test/codel-queue-disc-test-suite.cc
View File

@@ -435,7 +435,7 @@ CoDelQueueDiscControlLawTest::_codel_control_law(uint32_t t, uint32_t interval,
return t + _reciprocal_scale(interval, recInvSqrt << REC_INV_SQRT_SHIFT_ns3);
}
// End Linux borrrow
// End Linux borrow
void
CoDelQueueDiscControlLawTest::DoRun()

10
src/wave/examples/vanet-routing-compare.cc
View File

@@ -236,7 +236,7 @@ class RoutingStats
void SetTxPkts(uint32_t txPkts);
private:
uint32_t m_RxBytes; ///< reeive bytes
uint32_t m_RxBytes; ///< receive bytes
uint32_t m_cumulativeRxBytes; ///< cumulative receive bytes
uint32_t m_RxPkts; ///< receive packets
uint32_t m_cumulativeRxPkts; ///< cumulative receive packets
@@ -731,7 +731,7 @@ class WifiPhyStats : public Object
uint32_t GetTxBytes();
/**
* \brief Callback signiture for Phy/Tx trace
* \brief Callback signature for Phy/Tx trace
* \param context this object
* \param packet packet transmitted
* \param mode wifi mode
@@ -745,14 +745,14 @@ class WifiPhyStats : public Object
uint8_t txPower);
/**
* \brief Callback signiture for Phy/TxDrop
* \brief Callback signature for Phy/TxDrop
* \param context this object
* \param packet the tx packet being dropped
*/
void PhyTxDrop(std::string context, Ptr<const Packet> packet);
/**
* \brief Callback signiture for Phy/RxDrop
* \brief Callback signature for Phy/RxDrop
* \param context this object
* \param packet the rx packet being dropped
* \param reason the reason for the drop
@@ -2255,7 +2255,7 @@ VanetRoutingExperiment::SetupAdhocDevices()
wifiChannel.SetPropagationDelay("ns3::ConstantSpeedPropagationDelayModel");
if (m_lossModel == 3)
{
// two-ray requires antenna height (else defaults to Friss)
// two-ray requires antenna height (else defaults to Friis)
wifiChannel.AddPropagationLoss(m_lossModelName,
"Frequency",
DoubleValue(freq),

2
src/wave/helper/wave-bsm-stats.h
View File

@@ -226,7 +226,7 @@ class WaveBsmStats : public Object
int m_wavePktSendCount; ///< packet sent count
int m_waveByteSendCount; ///< byte sent count
int m_wavePktReceiveCount; ///< packet receive count
std::vector<int> m_wavePktInCoverageReceiveCounts; ///< packet in ceoverage receive counts
std::vector<int> m_wavePktInCoverageReceiveCounts; ///< packet in coverage receive counts
std::vector<int> m_wavePktExpectedReceiveCounts; ///< packet expected receive counts
std::vector<int>
m_waveTotalPktInCoverageReceiveCounts; ///< total packet in coverage receive counts

2
src/wifi/model/threshold-preamble-detection-model.cc
View File

@@ -40,7 +40,7 @@ ThresholdPreambleDetectionModel::GetTypeId()
.SetGroupName("Wifi")
.AddConstructor<ThresholdPreambleDetectionModel>()
.AddAttribute("Threshold",
"Preamble is successfully detection if the SNR is at or above this value "
"Preamble is successfully detected if the SNR is at or above this value "
"(expressed in dB).",
DoubleValue(4),
MakeDoubleAccessor(&ThresholdPreambleDetectionModel::m_threshold),

6
src/wifi/test/tx-duration-test.cc
View File

@@ -1308,7 +1308,7 @@ class HeSigBDurationTest : public TestCase
private:
/**
* Build a TXVECTOR for HE MU with the given bandwith and user informations.
* Build a TXVECTOR for HE MU with the given bandwidth and user informations.
*
* \param bw the channel width of the PPDU in MHz
* \param userInfos the list of HE MU specific user transmission parameters
@@ -1762,8 +1762,8 @@ PhyHeaderSectionsTest::DoRun()
// ==================================================================================
// 11be (EHT)
sections.erase(WIFI_PPDU_FIELD_SIG_A); // FIXME: do we keep using seperate type for 11be?
sections.erase(WIFI_PPDU_FIELD_SIG_B); // FIXME: do we keep using seperate type for 11be?
sections.erase(WIFI_PPDU_FIELD_SIG_A); // FIXME: do we keep using separate type for 11be?
sections.erase(WIFI_PPDU_FIELD_SIG_B); // FIXME: do we keep using separate type for 11be?
phyEntity = Create<EhtPhy>();
txVector.SetChannelWidth(20);
txVector.SetNss(2); // EHT-LTF duration assumed to be always 8 us for the time being (see note