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

doc: remove trailing white space in attributes and trace source strings

Browse Source
This commit is contained in:
Peter D. Barnes, Jr
2022-08-29 23:34:04 -07:00
committed by Tommaso Pecorella
parent e899941026
commit c9b72c7a35
18 changed files with 66 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/buildings/model/buildings-propagation-loss-model.cc
View File

@@ -69,18 +69,18 @@ BuildingsPropagationLossModel::GetTypeId (void)
.AddAttribute ("ShadowSigmaOutdoor",
"Standard deviation of the normal distribution used for calculate the shadowing for outdoor nodes",
"Standard deviation of the normal distribution used to calculate the shadowing for outdoor nodes",
DoubleValue (7.0),
MakeDoubleAccessor (&BuildingsPropagationLossModel::m_shadowingSigmaOutdoor),
MakeDoubleChecker<double> ())
.AddAttribute ("ShadowSigmaIndoor",
"Standard deviation of the normal distribution used for calculate the shadowing for indoor nodes ",
"Standard deviation of the normal distribution used to calculate the shadowing for indoor nodes",
DoubleValue (8.0),
MakeDoubleAccessor (&BuildingsPropagationLossModel::m_shadowingSigmaIndoor),
MakeDoubleChecker<double> ())
.AddAttribute ("ShadowSigmaExtWalls",
"Standard deviation of the normal distribution used for calculate the shadowing due to ext walls ",
"Standard deviation of the normal distribution used to calculate the shadowing due to ext walls",
DoubleValue (5.0),
MakeDoubleAccessor (&BuildingsPropagationLossModel::m_shadowingSigmaExtWalls),
MakeDoubleChecker<double> ())

33
src/dsdv/model/dsdv-routing-protocol.cc
View File

@@ -120,51 +120,62 @@ RoutingProtocol::GetTypeId (void)
.SetParent<Ipv4RoutingProtocol> ()
.SetGroupName ("Dsdv")
.AddConstructor<RoutingProtocol> ()
.AddAttribute ("PeriodicUpdateInterval","Periodic interval between exchange of full routing tables among nodes. ",
.AddAttribute ("PeriodicUpdateInterval",
"Periodic interval between exchange of full routing tables among nodes.",
TimeValue (Seconds (15)),
MakeTimeAccessor (&RoutingProtocol::m_periodicUpdateInterval),
MakeTimeChecker ())
.AddAttribute ("SettlingTime", "Minimum time an update is to be stored in adv table before sending out"
.AddAttribute ("SettlingTime",
"Minimum time an update is to be stored in adv table before sending out "
"in case of change in metric (in seconds)",
TimeValue (Seconds (5)),
MakeTimeAccessor (&RoutingProtocol::m_settlingTime),
MakeTimeChecker ())
.AddAttribute ("MaxQueueLen", "Maximum number of packets that we allow a routing protocol to buffer.",
.AddAttribute ("MaxQueueLen",
"Maximum number of packets that we allow a routing protocol to buffer.",
UintegerValue (500 /*assuming maximum nodes in simulation is 100*/),
MakeUintegerAccessor (&RoutingProtocol::m_maxQueueLen),
MakeUintegerChecker<uint32_t> ())
.AddAttribute ("MaxQueuedPacketsPerDst", "Maximum number of packets that we allow per destination to buffer.",
.AddAttribute ("MaxQueuedPacketsPerDst",
"Maximum number of packets that we allow per destination to buffer.",
UintegerValue (5),
MakeUintegerAccessor (&RoutingProtocol::m_maxQueuedPacketsPerDst),
MakeUintegerChecker<uint32_t> ())
.AddAttribute ("MaxQueueTime","Maximum time packets can be queued (in seconds)",
.AddAttribute ("MaxQueueTime",
"Maximum time packets can be queued (in seconds)",
TimeValue (Seconds (30)),
MakeTimeAccessor (&RoutingProtocol::m_maxQueueTime),
MakeTimeChecker ())
.AddAttribute ("EnableBuffering","Enables buffering of data packets if no route to destination is available",
.AddAttribute ("EnableBuffering",
"Enables buffering of data packets if no route to destination is available",
BooleanValue (true),
MakeBooleanAccessor (&RoutingProtocol::SetEnableBufferFlag,
&RoutingProtocol::GetEnableBufferFlag),
MakeBooleanChecker ())
.AddAttribute ("EnableWST","Enables Weighted Settling Time for the updates before advertising",
.AddAttribute ("EnableWST",
"Enables Weighted Settling Time for the updates before advertising",
BooleanValue (true),
MakeBooleanAccessor (&RoutingProtocol::SetWSTFlag,
&RoutingProtocol::GetWSTFlag),
MakeBooleanChecker ())
.AddAttribute ("Holdtimes","Times the forwarding Interval to purge the route.",
.AddAttribute ("Holdtimes",
"Times the forwarding Interval to purge the route.",
UintegerValue (3),
MakeUintegerAccessor (&RoutingProtocol::Holdtimes),
MakeUintegerChecker<uint32_t> ())
.AddAttribute ("WeightedFactor","WeightedFactor for the settling time if Weighted Settling Time is enabled",
.AddAttribute ("WeightedFactor",
"WeightedFactor for the settling time if Weighted Settling Time is enabled",
DoubleValue (0.875),
MakeDoubleAccessor (&RoutingProtocol::m_weightedFactor),
MakeDoubleChecker<double> ())
.AddAttribute ("EnableRouteAggregation","Enables Weighted Settling Time for the updates before advertising",
.AddAttribute ("EnableRouteAggregation",
"Enables Weighted Settling Time for the updates before advertising",
BooleanValue (false),
MakeBooleanAccessor (&RoutingProtocol::SetEnableRAFlag,
&RoutingProtocol::GetEnableRAFlag),
MakeBooleanChecker ())
.AddAttribute ("RouteAggregationTime","Time to aggregate updates before sending them out (in seconds)",
.AddAttribute ("RouteAggregationTime",
"Time to aggregate updates before sending them out (in seconds)",
TimeValue (Seconds (1)),
MakeTimeAccessor (&RoutingProtocol::m_routeAggregationTime),
MakeTimeChecker ());

2
src/internet-apps/model/dhcp-client.cc
View File

@@ -58,7 +58,7 @@ DhcpClient::GetTypeId (void)
MakeTimeAccessor (&DhcpClient::m_nextoffer),
MakeTimeChecker ())
.AddAttribute ("Transactions",
"The possible value of transaction numbers ",
"The possible value of transaction numbers",
StringValue ("ns3::UniformRandomVariable[Min=0.0|Max=1000000.0]"),
MakePointerAccessor (&DhcpClient::m_ran),
MakePointerChecker<RandomVariableStream> ())

2
src/internet/model/tcp-socket-base.cc
View File

@@ -230,7 +230,7 @@ TcpSocketBase::GetTypeId (void)
MakeTraceSourceAccessor (&TcpSocketBase::m_ecnEchoSeq),
"ns3::SequenceNumber32TracedValueCallback")
.AddTraceSource ("EcnCeSeq",
"Sequence of last received CE ",
"Sequence of last received CE",
MakeTraceSourceAccessor (&TcpSocketBase::m_ecnCESeq),
"ns3::SequenceNumber32TracedValueCallback")
.AddTraceSource ("EcnCwrSeq",

2
src/lr-wpan/model/lr-wpan-mac.cc
View File

@@ -136,7 +136,7 @@ LrWpanMac::GetTypeId (void)
"ns3::LrWpanMac::SentTracedCallback")
.AddTraceSource ("IfsEnd",
"Trace source reporting the end of an "
"Interframe space (IFS) ",
"Interframe space (IFS)",
MakeTraceSourceAccessor (&LrWpanMac::m_macIfsEndTrace),
"ns3::Packet::TracedCallback")
;

10
src/lte/helper/lte-helper.cc
View File

@@ -161,8 +161,8 @@ TypeId LteHelper::GetTypeId (void)
MakeBooleanAccessor (&LteHelper::m_isAnrEnabled),
MakeBooleanChecker ())
.AddAttribute ("UsePdschForCqiGeneration",
"If true, DL-CQI will be calculated from PDCCH as signal and PDSCH as interference "
"If false, DL-CQI will be calculated from PDCCH as signal and PDCCH as interference ",
"If true, DL-CQI will be calculated from PDCCH as signal and PDSCH as interference. "
"If false, DL-CQI will be calculated from PDCCH as signal and PDCCH as interference.",
BooleanValue (true),
MakeBooleanAccessor (&LteHelper::m_usePdschForCqiGeneration),
MakeBooleanChecker ())
@@ -183,14 +183,14 @@ TypeId LteHelper::GetTypeId (void)
&LteHelper::GetUeComponentCarrierManagerType),
MakeStringChecker ())
.AddAttribute ("UseCa",
"If true, Carrier Aggregation feature is enabled and a valid Component Carrier Map is expected."
"If true, Carrier Aggregation feature is enabled and a valid Component Carrier Map is expected. "
"If false, single carrier simulation.",
BooleanValue (false),
MakeBooleanAccessor (&LteHelper::m_useCa),
MakeBooleanChecker ())
.AddAttribute ("NumberOfComponentCarriers",
"Set the number of Component carrier to use "
"If it is more than one and m_useCa is false, it will raise an error ",
"Set the number of Component carrier to use. "
"If it is more than one and m_useCa is false, it will raise an error.",
UintegerValue (1),
MakeUintegerAccessor (&LteHelper::m_noOfCcs),
MakeUintegerChecker<uint16_t> (MIN_NO_CC, MAX_NO_CC))

16
src/lte/helper/radio-environment-map-helper.cc
View File

@@ -114,12 +114,14 @@ RadioEnvironmentMapHelper::GetTypeId (void)
UintegerValue (100),
MakeUintegerAccessor (&RadioEnvironmentMapHelper::m_yRes),
MakeUintegerChecker<uint16_t> (2,std::numeric_limits<uint16_t>::max ()))
.AddAttribute ("Z", "The value of the z coordinate for which the map is to be generated",
DoubleValue (0.0),
.AddAttribute ("Z",
"The value of the z coordinate for which the map is to be generated",
DoubleValue (0.0),
MakeDoubleAccessor (&RadioEnvironmentMapHelper::m_z),
MakeDoubleChecker<double> ())
.AddAttribute ("StopWhenDone", "If true, Simulator::Stop () will be called as soon as the REM has been generated",
BooleanValue (true),
.AddAttribute ("StopWhenDone",
"If true, Simulator::Stop () will be called as soon as the REM has been generated",
BooleanValue (true),
MakeBooleanAccessor (&RadioEnvironmentMapHelper::m_stopWhenDone),
MakeBooleanChecker ())
.AddAttribute ("NoisePower",
@@ -133,7 +135,7 @@ RadioEnvironmentMapHelper::GetTypeId (void)
MakeUintegerChecker<uint32_t> (1,std::numeric_limits<uint32_t>::max ()))
.AddAttribute ("Earfcn",
"E-UTRA Absolute Radio Frequency Channel Number (EARFCN) "
"as per 3GPP 36.101 Section 5.7.3. ",
"as per 3GPP 36.101 Section 5.7.3.",
UintegerValue (100),
MakeUintegerAccessor (&RadioEnvironmentMapHelper::m_earfcn),
MakeUintegerChecker<uint16_t> ())
@@ -144,12 +146,12 @@ RadioEnvironmentMapHelper::GetTypeId (void)
&RadioEnvironmentMapHelper::GetBandwidth),
MakeUintegerChecker<uint16_t> ())
.AddAttribute ("UseDataChannel",
"If true, REM will be generated for PDSCH and for PDCCH otherwise ",
"If true, REM will be generated for PDSCH and for PDCCH otherwise",
BooleanValue (false),
MakeBooleanAccessor (&RadioEnvironmentMapHelper::m_useDataChannel),
MakeBooleanChecker ())
.AddAttribute ("RbId",
"Resource block Id, for which REM will be generated,"
"Resource block Id, for which REM will be generated, "
"default value is -1, what means REM will be averaged from all RBs",
IntegerValue (-1),
MakeIntegerAccessor (&RadioEnvironmentMapHelper::m_rbId),

6
src/lte/model/component-carrier.cc
View File

@@ -51,14 +51,14 @@ TypeId ComponentCarrier::GetTypeId (void)
MakeUintegerChecker<uint8_t> ())
.AddAttribute ("DlEarfcn",
"Downlink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) "
"as per 3GPP 36.101 Section 5.7.3. ",
"as per 3GPP 36.101 Section 5.7.3.",
UintegerValue (100),
MakeUintegerAccessor (&ComponentCarrier::SetDlEarfcn,
&ComponentCarrier::GetDlEarfcn),
MakeUintegerChecker<uint32_t> (0, 262143))
.AddAttribute ("UlEarfcn",
"Uplink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) "
"as per 3GPP 36.101 Section 5.7.3. ",
"as per 3GPP 36.101 Section 5.7.3.",
UintegerValue (18100),
MakeUintegerAccessor (&ComponentCarrier::SetUlEarfcn,
&ComponentCarrier::GetUlEarfcn),
@@ -262,5 +262,3 @@ ComponentCarrierBaseStation::SetCellId (uint16_t cellId)
}
} // namespace ns3

4
src/lte/model/lte-enb-net-device.cc
View File

@@ -111,13 +111,13 @@ TypeId LteEnbNetDevice::GetTypeId (void)
MakeUintegerChecker<uint16_t> ())
.AddAttribute ("DlEarfcn",
"Downlink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) "
"as per 3GPP 36.101 Section 5.7.3. ",
"as per 3GPP 36.101 Section 5.7.3.",
UintegerValue (100),
MakeUintegerAccessor (&LteEnbNetDevice::m_dlEarfcn),
MakeUintegerChecker<uint32_t> (0, 262143))
.AddAttribute ("UlEarfcn",
"Uplink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) "
"as per 3GPP 36.101 Section 5.7.3. ",
"as per 3GPP 36.101 Section 5.7.3.",
UintegerValue (18100),
MakeUintegerAccessor (&LteEnbNetDevice::m_ulEarfcn),
MakeUintegerChecker<uint32_t> (0, 262143))

5
src/lte/model/lte-enb-rrc.cc
View File

@@ -1788,7 +1788,7 @@ LteEnbRrc::GetTypeId (void)
MakeUintegerAccessor (&LteEnbRrc::m_defaultTransmissionMode),
MakeUintegerChecker<uint8_t> ())
.AddAttribute ("EpsBearerToRlcMapping",
"Specify which type of RLC will be used for each type of EPS bearer. ",
"Specify which type of RLC will be used for each type of EPS bearer.",
EnumValue (RLC_SM_ALWAYS),
MakeEnumAccessor (&LteEnbRrc::m_epsBearerToRlcMapping),
MakeEnumChecker (RLC_SM_ALWAYS, "RlcSmAlways",
@@ -1866,7 +1866,7 @@ LteEnbRrc::GetTypeId (void)
MakeIntegerAccessor (&LteEnbRrc::m_qRxLevMin),
MakeIntegerChecker<int8_t> (-70, -22))
.AddAttribute ("NumberOfComponentCarriers",
"Number of Component Carriers ",
"Number of Component Carriers",
UintegerValue (1),
MakeIntegerAccessor (&LteEnbRrc::m_numberOfComponentCarriers),
MakeIntegerChecker<int16_t> (MIN_NO_CC, MAX_NO_CC))
@@ -3213,4 +3213,3 @@ LteEnbRrc::IsRandomAccessCompleted (uint16_t rnti)
} // namespace ns3

4
src/lte/model/lte-ue-net-device.cc
View File

@@ -93,7 +93,7 @@ TypeId LteUeNetDevice::GetTypeId (void)
MakeUintegerChecker<uint64_t> ())
.AddAttribute ("DlEarfcn",
"Downlink E-UTRA Absolute Radio Frequency Channel Number (EARFCN) "
"as per 3GPP 36.101 Section 5.7.3. ",
"as per 3GPP 36.101 Section 5.7.3.",
UintegerValue (100),
MakeUintegerAccessor (&LteUeNetDevice::SetDlEarfcn,
&LteUeNetDevice::GetDlEarfcn),
@@ -102,7 +102,7 @@ TypeId LteUeNetDevice::GetTypeId (void)
"The Closed Subscriber Group (CSG) identity that this UE is associated with, "
"i.e., giving the UE access to cells which belong to this particular CSG. "
"This restriction only applies to initial cell selection and EPC-enabled simulation. "
"This does not revoke the UE's access to non-CSG cells. ",
"This does not revoke the UE's access to non-CSG cells.",
UintegerValue (0),
MakeUintegerAccessor (&LteUeNetDevice::SetCsgId,
&LteUeNetDevice::GetCsgId),

2
src/propagation/model/cost231-propagation-loss-model.cc
View File

@@ -61,7 +61,7 @@ Cost231PropagationLossModel::GetTypeId (void)
MakeDoubleAccessor (&Cost231PropagationLossModel::m_SSAntennaHeight),
MakeDoubleChecker<double> ())
.AddAttribute ("MinDistance",
"The distance under which the propagation model refuses to give results (m) ",
"The distance under which the propagation model refuses to give results (m).",
DoubleValue (0.5),
MakeDoubleAccessor (&Cost231PropagationLossModel::SetMinDistance, &Cost231PropagationLossModel::GetMinDistance),
MakeDoubleChecker<double> ());

4
src/propagation/model/propagation-loss-model.cc
View File

@@ -150,7 +150,7 @@ FriisPropagationLossModel::GetTypeId (void)
.SetGroupName ("Propagation")
.AddConstructor<FriisPropagationLossModel> ()
.AddAttribute ("Frequency",
"The carrier frequency (in Hz) at which propagation occurs (default is 5.15 GHz).",
"The carrier frequency (in Hz) at which propagation occurs (default is 5.15 GHz).",
DoubleValue (5.150e9),
MakeDoubleAccessor (&FriisPropagationLossModel::SetFrequency,
&FriisPropagationLossModel::GetFrequency),
@@ -160,7 +160,7 @@ FriisPropagationLossModel::GetTypeId (void)
MakeDoubleAccessor (&FriisPropagationLossModel::m_systemLoss),
MakeDoubleChecker<double> ())
.AddAttribute ("MinLoss",
"The minimum value (dB) of the total loss, used at short ranges. Note: ",
"The minimum value (dB) of the total loss, used at short ranges.",
DoubleValue (0.0),
MakeDoubleAccessor (&FriisPropagationLossModel::SetMinLoss,
&FriisPropagationLossModel::GetMinLoss),

16
src/spectrum/model/spectrum-channel.cc
View File

@@ -65,7 +65,7 @@ SpectrumChannel::GetTypeId (void)
"the computational load by not propagating signals "
"that are far beyond the interference range. Note that "
"the default value corresponds to considering all signals "
"for reception. Tune this value with care. ",
"for reception. Tune this value with care.",
DoubleValue (1.0e9),
MakeDoubleAccessor (&SpectrumChannel::m_maxLossDb),
MakeDoubleChecker<double> ())
@@ -79,11 +79,11 @@ SpectrumChannel::GetTypeId (void)
.AddTraceSource ("Gain",
"This trace is fired whenever a new path loss value "
"is calculated. The parameters to this trace are : "
"Pointer to the mobility model of the transmitter"
"Pointer to the mobility model of the receiver"
"Tx antenna gain"
"Rx antenna gain"
"Propagation gain"
"Pointer to the mobility model of the transmitter, "
"Pointer to the mobility model of the receiver, "
"Tx antenna gain, "
"Rx antenna gain, "
"Propagation gain, "
"Pathloss",
MakeTraceSourceAccessor (&SpectrumChannel::m_gainTrace),
"ns3::SpectrumChannel::GainTracedCallback")
@@ -99,12 +99,12 @@ SpectrumChannel::GetTypeId (void)
"AntennaModels and the PropagationLossModel. "
"In particular, note that SpectrumPropagationLossModel "
"(even if present) is never used to evaluate the "
"loss value reported in this trace. ",
"loss value reported in this trace.",
MakeTraceSourceAccessor (&SpectrumChannel::m_pathLossTrace),
"ns3::SpectrumChannel::LossTracedCallback")
.AddTraceSource ("TxSigParams",
"This trace is fired whenever a signal is transmitted."
"This trace is fired whenever a signal is transmitted. "
"The sole parameter is a pointer to a copy of the "
"SpectrumSignalParameters provided by the transmitter.",
MakeTraceSourceAccessor (&SpectrumChannel::m_txSigParamsTrace),

4
src/wifi/model/rate-control/minstrel-ht-wifi-manager.cc
View File

@@ -80,12 +80,12 @@ MinstrelHtWifiManager::GetTypeId (void)
.AddConstructor<MinstrelHtWifiManager> ()
.SetGroupName ("Wifi")
.AddAttribute ("UpdateStatistics",
"The interval between updating statistics table ",
"The interval between updating statistics table",
TimeValue (MilliSeconds (50)),
MakeTimeAccessor (&MinstrelHtWifiManager::m_updateStats),
MakeTimeChecker ())
.AddAttribute ("LegacyUpdateStatistics",
"The interval between updating statistics table (for legacy Minstrel) ",
"The interval between updating statistics table (for legacy Minstrel)",
TimeValue (MilliSeconds (100)),
MakeTimeAccessor (&MinstrelHtWifiManager::m_legacyUpdateStats),
MakeTimeChecker ())

2
src/wifi/model/rate-control/minstrel-ht-wifi-manager.h
View File

@@ -620,7 +620,7 @@ private:
uint8_t m_lookAroundRate; //!< The % to try other rates than our current rate.
uint8_t m_ewmaLevel; //!< Exponential weighted moving average level (or coefficient).
uint8_t m_nSampleCol; //!< Number of sample columns.
uint32_t m_frameLength; //!< Frame length used for calculate modes TxTime in bytes.
uint32_t m_frameLength; //!< Frame length used to calculate modes TxTime in bytes.
uint8_t m_numGroups; //!< Number of groups Minstrel should consider.
uint8_t m_numRates; //!< Number of rates per group Minstrel should consider.
bool m_useLatestAmendmentOnly; //!< Flag if only the latest supported amendment by both peers should be used.

2
src/wifi/model/rate-control/minstrel-wifi-manager.cc
View File

@@ -54,7 +54,7 @@ MinstrelWifiManager::GetTypeId (void)
.SetGroupName ("Wifi")
.AddConstructor<MinstrelWifiManager> ()
.AddAttribute ("UpdateStatistics",
"The interval between updating statistics table ",
"The interval between updating statistics table",
TimeValue (Seconds (0.1)),
MakeTimeAccessor (&MinstrelWifiManager::m_updateStats),
MakeTimeChecker ())

2
src/wifi/model/wifi-phy.cc
View File

@@ -81,7 +81,7 @@ WifiPhy::GetTypeId (void)
"standard and band are used. If the channel number is 0, the default "
"channel number for the configured standard, band and channel width is used."
"Note that the channel width can be left unspecified (0) if the channel "
"number uniquely identify a frequency channel for the given standard and band. ",
"number uniquely identify a frequency channel for the given standard and band.",
StringValue ("{0, 0, BAND_UNSPECIFIED, 0}"),
MakeTupleAccessor <UintegerValue, UintegerValue, EnumValue, UintegerValue> (&WifiPhy::SetOperatingChannel),
MakeTupleChecker<UintegerValue, UintegerValue, EnumValue, UintegerValue>