--- a/src/devices/wifi/wifi-remote-station-manager.h Mon Mar 29 12:21:07 2010 -0400
+++ b/src/devices/wifi/wifi-remote-station-manager.h Mon Mar 29 20:01:19 2010 -0400
@@ -142,6 +142,8 @@
void RecordDisassociated (Mac48Address address);
/**
+ * \param address remote address
+ * \param header MAC header
* \param packet the packet to queue
* \param fullPacketSize the size of the packet after its 802.11 MAC header has been added.
*
@@ -153,6 +155,8 @@
void PrepareForQueue (Mac48Address address, const WifiMacHeader *header,
Ptr<const Packet> packet, uint32_t fullPacketSize);
/**
+ * \param address remote address
+ * \param header MAC header
* \param packet the packet to send
* \param fullPacketSize the size of the packet after its 802.11 MAC header has been added.
* \returns the transmission mode to use to send this packet
@@ -160,6 +164,8 @@
WifiMode GetDataMode (Mac48Address address, const WifiMacHeader *header,
Ptr<const Packet> packet, uint32_t fullPacketSize);
/**
+ * \param address remote address
+ * \param header MAC header
* \param packet the packet to send
* \returns the transmission mode to use to send the RTS prior to the
* transmission of the data packet itself.
@@ -200,6 +206,8 @@
void ReportFinalDataFailed (Mac48Address address, const WifiMacHeader *header);
/**
+ * \param address remote address
+ * \param header MAC header
* \param rxSnr the snr of the packet received
* \param txMode the transmission mode used for the packet received.
*
@@ -209,6 +217,8 @@
double rxSnr, WifiMode txMode);
/**
+ * \param address remote address
+ * \param header MAC header
* \param packet the packet to send
* \returns true if we want to use an RTS/CTS handshake for this
* packet before sending it, false otherwise.
@@ -216,6 +226,8 @@
bool NeedRts (Mac48Address address, const WifiMacHeader *header,
Ptr<const Packet> packet);
/**
+ * \param address remote address
+ * \param header MAC header
* \param packet the packet to send
* \returns true if we want to restart a failed RTS/CTS
* handshake, false otherwise.
@@ -223,6 +235,8 @@
bool NeedRtsRetransmission (Mac48Address address, const WifiMacHeader *header,
Ptr<const Packet> packet);
/**
+ * \param address remote address
+ * \param header MAC header
* \param packet the packet to send
* \returns true if we want to resend a packet
* after a failed transmission attempt, false otherwise.
@@ -231,12 +245,16 @@
Ptr<const Packet> packet);
/**
+ * \param address remote address
+ * \param header MAC header
* \param packet the packet to send
* \returns true if this packet should be fragmented, false otherwise.
*/
bool NeedFragmentation (Mac48Address address, const WifiMacHeader *header,
Ptr<const Packet> packet);
/**
+ * \param address remote address
+ * \param header MAC header
* \param packet the packet to send
* \param fragmentNumber the fragment index of the next fragment to send (starts at zero).
* \returns the size of the corresponding fragment.
@@ -244,6 +262,8 @@
uint32_t GetFragmentSize (Mac48Address address, const WifiMacHeader *header,
Ptr<const Packet> packet, uint32_t fragmentNumber);
/**
+ * \param address remote address
+ * \param header MAC header
* \param packet the packet to send
* \param fragmentNumber the fragment index of the next fragment to send (starts at zero).
* \returns the offset within the original packet where this fragment starts.
@@ -251,6 +271,8 @@
uint32_t GetFragmentOffset (Mac48Address address, const WifiMacHeader *header,
Ptr<const Packet> packet, uint32_t fragmentNumber);
/**
+ * \param address remote address
+ * \param header MAC header
* \param packet the packet to send
* \param fragmentNumber the fragment index of the next fragment to send (starts at zero).
* \returns true if this is the last fragment, false otherwise.
@@ -259,12 +281,14 @@
Ptr<const Packet> packet, uint32_t fragmentNumber);
/**
+ * \param address remote address
* \param rtsMode the transmission mode used to send an RTS we just received
* \returns the transmission mode to use for the CTS to complete the RTS/CTS
* handshake.
*/
WifiMode GetCtsMode (Mac48Address address, WifiMode rtsMode);
/**
+ * \param address
* \param dataMode the transmission mode used to send an ACK we just received
* \returns the transmission mode to use for the ACK to complete the data/ACK
* handshake.
--- a/src/helper/trace-helper.h Mon Mar 29 12:21:07 2010 -0400
+++ b/src/helper/trace-helper.h Mon Mar 29 20:01:19 2010 -0400
@@ -361,7 +361,7 @@
* @brief Enable pcap output the indicated net device using a device previously
* named using the ns-3 object name service.
*
- * @param filename filename prefix to use for pcap files.
+ * @param prefix filename prefix to use for pcap files.
* @param ndName The name of the net device in which you want to enable tracing.
* @param promiscuous If true capture all possible packets available at the device.
* @param explicitFilename Treat the prefix as an explicit filename if true
@@ -393,6 +393,8 @@
* a previously created node) and associated device-id.
*
* @param prefix Filename prefix to use for pcap files.
+ * @param nodeid the node id
+ * @param deviceid the device id
* @param promiscuous If true capture all possible packets available at the device.
*/
void EnablePcap (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool promiscuous = false);
@@ -475,7 +477,7 @@
* @brief Enable ascii trace output the indicated net device using a device
* previously named using the ns-3 object name service.
*
- * @param filename filename prefix to use for ascii files.
+ * @param prefix filename prefix to use for ascii files.
* @param ndName The name of the net device in which you want to enable tracing.
* @param explicitFilename Treat the prefix as an explicit filename if true
*/
@@ -648,7 +650,7 @@
* @brief Enable pcap output the indicated Ipv4 and interface pair using a
* Ptr<Ipv4> previously named using the ns-3 object name service.
*
- * @param filename filename prefix to use for pcap files.
+ * @param prefix filename prefix to use for pcap files.
* @param ipv4Name Name of the Ptr<Ipv4> on which you want to enable tracing.
* @param interface Interface on ipv4 on which you want to enable tracing.
* @param explicitFilename Treat the prefix as an explicit filename if true.
@@ -679,10 +681,8 @@
* determines the Ipv4.
*
* @param prefix Filename prefix to use for pcap files.
- * @param nodeid The node identifier/number of the node on which to enable
- * ascii tracing
- * @param deviceid The device identifier/index of the device on which to enable
- * ascii tracing
+ * @param nodeid The node identifier/number of the node on which to enable tracing.
+ * @param interface Interface on ipv4 on which you want to enable tracing.
* @param explicitFilename Treat the prefix as an explicit filename if true
*/
void EnablePcapIpv4 (std::string prefix, uint32_t nodeid, uint32_t interface, bool explicitFilename);
@@ -769,7 +769,7 @@
* @brief Enable ascii trace output the indicated Ipv4 and interface pair
* using an Ipv4 previously named using the ns-3 object name service.
*
- * @param filename filename prefix to use for ascii files.
+ * @param prefix filename prefix to use for ascii files.
* @param ipv4Name The name of the Ipv4 on which you want to enable tracing.
* @param interface The interface on which you want to enable tracing.
* @param explicitFilename Treat the prefix as an explicit filename if true.
@@ -853,8 +853,8 @@
* @param prefix Filename prefix to use when creating ascii trace files
* @param nodeid The node identifier/number of the node on which to enable
* ascii tracing
- * @param interface The device identifier/index of the device on which to enable
- * ascii tracing
+ * @param deviceid The device identifier/index of the device on which to enable
+ * ascii tracing
* @param explicitFilename Treat the prefix as an explicit filename if true
*/
void EnableAsciiIpv4 (std::string prefix, uint32_t nodeid, uint32_t deviceid, bool explicitFilename);
@@ -958,7 +958,7 @@
* @brief Enable pcap output the indicated Ipv6 and interface pair using a
* Ptr<Ipv6> previously named using the ns-3 object name service.
*
- * @param filename filename prefix to use for pcap files.
+ * @param prefix filename prefix to use for pcap files.
* @param ipv6Name Name of the Ptr<Ipv6> on which you want to enable tracing.
* @param interface Interface on ipv6 on which you want to enable tracing.
* @param explicitFilename Treat the prefix as an explicit filename if true.
@@ -989,6 +989,8 @@
* determines the Ipv6.
*
* @param prefix Filename prefix to use for pcap files.
+ * @param nodeid The node identifier/number of the node on which to enable tracing.
+ * @param interface Interface on ipv6 on which you want to enable tracing.
* @param explicitFilename Treat the prefix as an explicit filename if true
*/
void EnablePcapIpv6 (std::string prefix, uint32_t nodeid, uint32_t interface, bool explicitFilename);
@@ -1074,7 +1076,7 @@
* @brief Enable ascii trace output the indicated Ipv6 and interface pair
* using an Ipv6 previously named using the ns-3 object name service.
*
- * @param filename filename prefix to use for ascii files.
+ * @param prefix filename prefix to use for ascii files.
* @param ipv6Name The name of the Ipv6 on which you want to enable tracing.
* @param interface The interface on which you want to enable tracing.
* @param explicitFilename Treat the prefix as an explicit filename if true.