# HG changeset patch # User Mathieu Lacage # Date 1212596324 25200 # Node ID 0c00342d6a735806ba68906d752d12bf49fefa74 # Parent 09b43ff43df03851109eb1abae87c603fc541d49 improve attribute documentation diff -r 09b43ff43df0 -r 0c00342d6a73 src/devices/wifi/adhoc-wifi-mac.cc --- a/src/devices/wifi/adhoc-wifi-mac.cc Wed Jun 04 14:02:06 2008 +0100 +++ b/src/devices/wifi/adhoc-wifi-mac.cc Wed Jun 04 09:18:44 2008 -0700 @@ -137,9 +137,7 @@ } void AdhocWifiMac::SetLinkDownCallback (Callback linkDown) -{ - //XXX -} +{} Mac48Address AdhocWifiMac::GetAddress (void) const { diff -r 09b43ff43df0 -r 0c00342d6a73 src/devices/wifi/dca-txop.cc --- a/src/devices/wifi/dca-txop.cc Wed Jun 04 14:02:06 2008 +0100 +++ b/src/devices/wifi/dca-txop.cc Wed Jun 04 09:18:44 2008 -0700 @@ -99,17 +99,17 @@ static TypeId tid = TypeId ("DcaTxop") .SetParent () .AddConstructor () - .AddAttribute ("MinCw", "XXX", + .AddAttribute ("MinCw", "The minimum value of the contention window.", UintegerValue (15), MakeUintegerAccessor (&DcaTxop::SetMinCw, &DcaTxop::GetMinCw), MakeUintegerChecker ()) - .AddAttribute ("MaxCw", "XXX", + .AddAttribute ("MaxCw", "The maximum value of the contention window.", UintegerValue (1023), MakeUintegerAccessor (&DcaTxop::SetMaxCw, &DcaTxop::GetMaxCw), MakeUintegerChecker ()) - .AddAttribute ("Aifsn", "XXX", + .AddAttribute ("Aifsn", "The AIFSN: the default value conforms to simple DCA.", UintegerValue (2), MakeUintegerAccessor (&DcaTxop::SetAifsn, &DcaTxop::GetAifsn), diff -r 09b43ff43df0 -r 0c00342d6a73 src/devices/wifi/nqsta-wifi-mac.cc --- a/src/devices/wifi/nqsta-wifi-mac.cc Wed Jun 04 14:02:06 2008 +0100 +++ b/src/devices/wifi/nqsta-wifi-mac.cc Wed Jun 04 09:18:44 2008 -0700 @@ -62,11 +62,11 @@ static TypeId tid = TypeId ("ns3::NqstaWifiMac") .SetParent () .AddConstructor () - .AddAttribute ("ProbeRequestTimeout", "XXX", + .AddAttribute ("ProbeRequestTimeout", "The interval between two consecutive probe request attempts.", TimeValue (Seconds (0.05)), MakeTimeAccessor (&NqstaWifiMac::m_probeRequestTimeout), MakeTimeChecker ()) - .AddAttribute ("AssocRequestTimeout", "XXX", + .AddAttribute ("AssocRequestTimeout", "The interval between two consecutive assoc request attempts.", TimeValue (Seconds (0.5)), MakeTimeAccessor (&NqstaWifiMac::m_assocRequestTimeout), MakeTimeChecker ()) @@ -76,7 +76,7 @@ UintegerValue (10), MakeUintegerAccessor (&NqstaWifiMac::m_maxMissedBeacons), MakeUintegerChecker ()) - .AddAttribute ("ActiveProbing", "XXX", + .AddAttribute ("ActiveProbing", "If true, we send probe requests. If false, we don't.", BooleanValue (false), MakeBooleanAccessor (&NqstaWifiMac::SetActiveProbing), MakeBooleanChecker ()) diff -r 09b43ff43df0 -r 0c00342d6a73 src/devices/wifi/onoe-wifi-manager.cc --- a/src/devices/wifi/onoe-wifi-manager.cc Wed Jun 04 14:02:06 2008 +0100 +++ b/src/devices/wifi/onoe-wifi-manager.cc Wed Jun 04 09:18:44 2008 -0700 @@ -40,7 +40,7 @@ TimeValue (Seconds (1.0)), MakeTimeAccessor (&OnoeWifiManager::m_updatePeriod), MakeTimeChecker ()) - .AddAttribute ("RaiseThreshold", "XXX", + .AddAttribute ("RaiseThreshold", "Attempt to raise the rate if we hit that threshold", UintegerValue (10), MakeUintegerAccessor (&OnoeWifiManager::m_raiseThreshold), MakeUintegerChecker ()) diff -r 09b43ff43df0 -r 0c00342d6a73 src/devices/wifi/propagation-loss-model.cc --- a/src/devices/wifi/propagation-loss-model.cc Wed Jun 04 14:02:06 2008 +0100 +++ b/src/devices/wifi/propagation-loss-model.cc Wed Jun 04 09:18:44 2008 -0700 @@ -55,7 +55,7 @@ static TypeId tid = TypeId ("ns3::RandomPropagationLossModel") .SetParent () .AddConstructor () - .AddAttribute ("Variable", "XXX", + .AddAttribute ("Variable", "The random variable used to pick a loss everytime GetLoss is invoked.", RandomVariableValue (ConstantVariable (1.0)), MakeRandomVariableAccessor (&RandomPropagationLossModel::m_variable), MakeRandomVariableChecker ()) diff -r 09b43ff43df0 -r 0c00342d6a73 src/devices/wifi/wifi-channel.cc --- a/src/devices/wifi/wifi-channel.cc Wed Jun 04 14:02:06 2008 +0100 +++ b/src/devices/wifi/wifi-channel.cc Wed Jun 04 09:18:44 2008 -0700 @@ -38,11 +38,11 @@ static TypeId tid = TypeId ("ns3::WifiChannel") .SetParent () .AddConstructor () - .AddAttribute ("PropagationLossModel", "XXX", + .AddAttribute ("PropagationLossModel", "A pointer to the propagation loss model attached to this channel.", PointerValue (), MakePointerAccessor (&WifiChannel::m_loss), MakePointerChecker ()) - .AddAttribute ("PropagationDelayModel", "XXX", + .AddAttribute ("PropagationDelayModel", "A pointer to the propagation delay model attached to this channel.", PointerValue (), MakePointerAccessor (&WifiChannel::m_delay), MakePointerChecker ()) diff -r 09b43ff43df0 -r 0c00342d6a73 src/devices/wifi/wifi-mac.cc --- a/src/devices/wifi/wifi-mac.cc Wed Jun 04 14:02:06 2008 +0100 +++ b/src/devices/wifi/wifi-mac.cc Wed Jun 04 09:18:44 2008 -0700 @@ -73,42 +73,43 @@ { static TypeId tid = TypeId ("ns3::WifiMac") .SetParent () - .AddAttribute ("CtsTimeout", "XXX", + .AddAttribute ("CtsTimeout", "When this timeout expires, the RTS/CTS handshake has failed.", TimeValue (GetDefaultCtsAckTimeout ()), MakeTimeAccessor (&WifiMac::m_ctsTimeout), MakeTimeChecker ()) - .AddAttribute ("AckTimeout", "XXX", + .AddAttribute ("AckTimeout", "When this timeout expires, the DATA/ACK handshake has failed.", TimeValue (GetDefaultCtsAckTimeout ()), MakeTimeAccessor (&WifiMac::m_ackTimeout), MakeTimeChecker ()) - .AddAttribute ("Sifs", "XXX", + .AddAttribute ("Sifs", "The value of the SIFS constant.", TimeValue (GetDefaultSifs ()), MakeTimeAccessor (&WifiMac::SetSifs, &WifiMac::GetSifs), MakeTimeChecker ()) - .AddAttribute ("EifsNoDifs", "XXX", + .AddAttribute ("EifsNoDifs", "The value of EIFS-DIFS", TimeValue (GetDefaultEifsNoDifs ()), MakeTimeAccessor (&WifiMac::SetEifsNoDifs, &WifiMac::GetEifsNoDifs), MakeTimeChecker ()) - .AddAttribute ("Slot", "XXX", + .AddAttribute ("Slot", "The duration of a Slot.", TimeValue (GetDefaultSlot ()), MakeTimeAccessor (&WifiMac::SetSlot, &WifiMac::GetSlot), MakeTimeChecker ()) - .AddAttribute ("Pifs", "XXX", + .AddAttribute ("Pifs", "The value of the PIFS constant.", TimeValue (GetDefaultSifs () + GetDefaultSlot ()), MakeTimeAccessor (&WifiMac::m_pifs), MakeTimeChecker ()) - .AddAttribute ("MaxPropagationDelay", "XXX", + .AddAttribute ("MaxPropagationDelay", "The maximum propagation delay. Unused for now.", TimeValue (GetDefaultMaxPropagationDelay ()), MakeTimeAccessor (&WifiMac::m_maxPropagationDelay), MakeTimeChecker ()) - .AddAttribute ("MaxMsduSize", "XXX", + .AddAttribute ("MaxMsduSize", "The maximum size of an MSDU accepted by the MAC layer." + "This value conforms to the specification.", UintegerValue (2304), MakeUintegerAccessor (&WifiMac::m_maxMsduSize), MakeUintegerChecker (1,2304)) - .AddAttribute ("Ssid", "XXX", + .AddAttribute ("Ssid", "The ssid we want to belong to.", SsidValue (Ssid ("default")), MakeSsidAccessor (&WifiMac::GetSsid, &WifiMac::SetSsid), diff -r 09b43ff43df0 -r 0c00342d6a73 src/devices/wifi/wifi-mac.h --- a/src/devices/wifi/wifi-mac.h Wed Jun 04 14:02:06 2008 +0100 +++ b/src/devices/wifi/wifi-mac.h Wed Jun 04 09:18:44 2008 -0700 @@ -70,13 +70,9 @@ */ void SetAckTimeout (Time ackTimeout); /** - * \param msduLifetime + * \param delay the max propagation delay. * - * XXX: I cannot remmeber what this is used for. - */ - void SetMsduLifetime (Time msduLifetime); - /** - * XXX: I cannot remember what this is used for. + * Unused for now. */ void SetMaxPropagationDelay (Time delay); @@ -105,11 +101,11 @@ */ Time GetAckTimeout (void) const; /** - * XXX: I cannot remember what this is used for. + * Unused for now. */ Time GetMsduLifetime (void) const; /** - * XXX: I cannot remember what this is used for. + * Unused for now. */ Time GetMaxPropagationDelay (void) const; /** diff -r 09b43ff43df0 -r 0c00342d6a73 src/devices/wifi/wifi-phy.cc --- a/src/devices/wifi/wifi-phy.cc Wed Jun 04 14:02:06 2008 +0100 +++ b/src/devices/wifi/wifi-phy.cc Wed Jun 04 09:18:44 2008 -0700 @@ -227,7 +227,8 @@ MakeDoubleAccessor (&WifiPhy::SetRxNoise, &WifiPhy::GetRxNoise), MakeDoubleChecker ()) - .AddAttribute ("Standard", "XXX", + .AddAttribute ("Standard", "The standard chosen configures a set of transmission modes" + " and some PHY-specific constants.", EnumValue (WIFI_PHY_STANDARD_80211a), MakeEnumAccessor (&WifiPhy::SetStandard), MakeEnumChecker (WIFI_PHY_STANDARD_80211a, "802.11a", @@ -712,7 +713,9 @@ return "SYNC"; break; default: - return "XXX"; + NS_ASSERT (false); + // quiet compiler + return "INVALID"; break; } } diff -r 09b43ff43df0 -r 0c00342d6a73 src/devices/wifi/wifi-remote-station-manager.cc --- a/src/devices/wifi/wifi-remote-station-manager.cc Wed Jun 04 14:02:06 2008 +0100 +++ b/src/devices/wifi/wifi-remote-station-manager.cc Wed Jun 04 09:18:44 2008 -0700 @@ -126,23 +126,32 @@ { static TypeId tid = TypeId ("ns3::WifiRemoteStationManager") .SetParent () - .AddAttribute ("IsLowLatency", "XXX", + .AddAttribute ("IsLowLatency", "If true, we attempt to modelize a so-called low-latency device: a device" + " where decisions about tx parameters can be made on a per-packet basis and feedback about the" + " transmission of each packet is obtained before sending the next. Otherwise, we modelize a " + " high-latency device, that is a device where we cannot update our decision about tx parameters" + " after every packet transmission.", BooleanValue (true), MakeBooleanAccessor (&WifiRemoteStationManager::m_isLowLatency), MakeBooleanChecker ()) - .AddAttribute ("MaxSsrc", "XXX", + .AddAttribute ("MaxSsrc", "The maximum number of retransmission attempts for an RTS. This value" + " will not have any effect on some rate control algorithms.", UintegerValue (7), MakeUintegerAccessor (&WifiRemoteStationManager::m_maxSsrc), MakeUintegerChecker ()) - .AddAttribute ("MaxSlrc", "XXX", + .AddAttribute ("MaxSlrc", "The maximum number of retransmission attempts for a DATA packet. This value" + " will not have any effect on some rate control algorithms.", UintegerValue (7), MakeUintegerAccessor (&WifiRemoteStationManager::m_maxSlrc), MakeUintegerChecker ()) - .AddAttribute ("RtsCtsThreshold", "XXX", + .AddAttribute ("RtsCtsThreshold", "If a data packet is bigger than this value, we use an RTS/CTS handshake" + " before sending the data. This value will not have any effect on some rate control algorithms.", UintegerValue (1500), MakeUintegerAccessor (&WifiRemoteStationManager::m_rtsCtsThreshold), MakeUintegerChecker ()) - .AddAttribute ("FragmentationThreshold", "XXX", + .AddAttribute ("FragmentationThreshold", "If a data packet is bigger than this value, we fragment it such that" + " the size of the fragments are equal or smaller than this value. This value will not have any effect" + " on some rate control algorithms.", UintegerValue (1500), MakeUintegerAccessor (&WifiRemoteStationManager::m_fragmentationThreshold), MakeUintegerChecker ()) @@ -402,9 +411,9 @@ { static TypeId tid = TypeId ("ns3::WifiRemoteStation") .SetParent () - .AddTraceSource ("Ssrc", "XXX", + .AddTraceSource ("Ssrc", "The value of the ssrc counter: indicates the number of retransmissions of RTS.", MakeTraceSourceAccessor (&WifiRemoteStation::m_ssrc)) - .AddTraceSource ("Slrc", "XXX", + .AddTraceSource ("Slrc", "The value of the slrc counter: indicates the number of retransmissions of DATA.", MakeTraceSourceAccessor (&WifiRemoteStation::m_slrc)) ; return tid;