Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(703)

Unified Diff: examples/wireless/wifi-clear-channel-cmu.cc

Issue 318430043: final updates to correct doxygen warnings for the examples module (Closed)
Patch Set: Updates to correct doxygen warnings for latest external changes. Created 7 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « examples/wireless/wifi-adhoc.cc ('k') | examples/wireless/wifi-spectrum-per-interference.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: examples/wireless/wifi-clear-channel-cmu.cc
===================================================================
--- a/examples/wireless/wifi-clear-channel-cmu.cc
+++ b/examples/wireless/wifi-clear-channel-cmu.cc
@@ -32,19 +32,57 @@
{
public:
Experiment ();
+ /**
+ * Constructor
+ * \param name the test name
+ */
Experiment (std::string name);
+ /**
+ * Run experiment
+ * \param wifi the wifi helper
+ * \param wifiPhy the wifi phy layer
+ * \param wifiMac the wifi MAC
+ * \param wifiChannel the wifi channel
+ * \returns the total number of packets
+ */
uint32_t Run (const WifiHelper &wifi, const YansWifiPhyHelper &wifiPhy,
const WifiMacHelper &wifiMac, const YansWifiChannelHelper &wifiChannel);
private:
+ /**
+ * Receive packet function
+ * \param socket the socket to receive on
+ */
void ReceivePacket (Ptr<Socket> socket);
+ /**
+ * Set position function
+ * \param node the node
+ * \param position the postion vector
+ */
void SetPosition (Ptr<Node> node, Vector position);
+ /**
+ * Get position function
+ * \param node the node
+ * \returns the position vector
+ */
Vector GetPosition (Ptr<Node> node);
+ /**
+ * Setup receive packetfunction
+ * \param node the node
+ * \returns the scoket to receive on
+ */
Ptr<Socket> SetupPacketReceive (Ptr<Node> node);
+ /**
+ * Generate traffic function
+ * \param socket the socket use
+ * \param pktSize the packet size
+ * \param pktCount the packet count
+ * \param pktInterval the packet interval
+ */
void GenerateTraffic (Ptr<Socket> socket, uint32_t pktSize,
uint32_t pktCount, Time pktInterval );
- uint32_t m_pktsTotal;
- Gnuplot2dDataset m_output;
+ uint32_t m_pktsTotal; ///< total bytes received
+ Gnuplot2dDataset m_output; ///< output data set
};
Experiment::Experiment ()
« no previous file with comments | « examples/wireless/wifi-adhoc.cc ('k') | examples/wireless/wifi-spectrum-per-interference.cc » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b