Fix doxygen errors

This commit is contained in:
Tom Henderson
2009-09-04 18:02:03 -07:00
parent a0612ce1e2
commit a355cc5bac
4 changed files with 11 additions and 17 deletions

View File

@@ -151,6 +151,7 @@ public:
* associated WifiMode is used.
* \param dataRate the rate (bits/second) at which the user data is transmitted
* \param phyRate the rate (bits/second) at which the encoded user data is transmitted
* \param standard the Wifi Phy standard to apply
* The phyRate includes FEC so, is typically higher than the dataRate.
*
* Create a BPSK WifiMode.
@@ -171,6 +172,7 @@ public:
* \param phyRate the rate (bits/second) at which the encoded user data is transmitted
* The phyRate includes FEC so, is typically higher than the dataRate.
* \param constellationSize the number of elements included in the QAM constellation.
* \param standard the Wifi Phy standard to apply
*
* Create a QAM WifiMode.
*/
@@ -190,6 +192,7 @@ public:
* associated WifiMode is used.
* \param dataRate the rate (bits/second) at which the user data is transmitted
* \param phyRate the rate (bits/second) at which the encoded user data is transmitted
* \param standard the Wifi Phy standard to apply
* The phyRate includes FEC so, is typically higher than the dataRate.
*
* Create a DBPSK WifiMode.
@@ -208,6 +211,7 @@ public:
* associated WifiMode is used.
* \param dataRate the rate (bits/second) at which the user data is transmitted
* \param phyRate the rate (bits/second) at which the encoded user data is transmitted
* \param standard the Wifi Phy standard to apply
* The phyRate includes FEC so, is typically higher than the dataRate.
*
* Create a DQPSK WifiMode.

View File

@@ -337,6 +337,7 @@ public:
* transmitted. This is because it is possible to have the receiver
* tuned on a given channel and still to be able to receive packets
* on a nearby channel.
* @param channelNumber the channel on which the packet is received
* @param rate the PHY data rate in units of 500kbps (i.e., the same
* units used both for the radiotap and for the prism header)
* @param isShortPreamble true if short preamble is used, false otherwise
@@ -351,14 +352,10 @@ public:
* Public method used to fire a PromiscSniffer trace for a wifi packet being transmitted. Implemented for encapsulation
* purposes.
*
* @param packet the packet being received
* @param packet the packet being transmitted
* @param channelFreqMhz the frequency in MHz at which the packet is
* received. Note that in real devices this is normally the
* frequency to which the receiver is tuned, and this can be
* different than the frequency at which the packet was originally
* transmitted. This is because it is possible to have the receiver
* tuned on a given channel and still to be able to receive packets
* on a nearby channel.
* transmitted.
* @param channelNumber the channel on which the packet is transmitted
* @param rate the PHY data rate in units of 500kbps (i.e., the same
* units used both for the radiotap and for the prism header)
* @param isShortPreamble true if short preamble is used, false otherwise

View File

@@ -615,8 +615,6 @@ public:
* advertisements after a network topology change by calling DiscoverLSAs
* and then by reading those advertisements.
*
* \param List of routing table entries of external routes to be injected.
*
* @see GlobalRoutingLSA
* @see GlobalRouter::GetLSA ()
* @returns The number of Global Routing Link State Advertisements.
@@ -700,13 +698,8 @@ public:
/**
* @brief Withdraw a route from the global unicast routing table.
*
* Calling this function will cause all indexed routes numbered above
* index i to have their index decremented. For instance, it is possible to
* remove N injected routes by calling RemoveInjectedRoute (0) N times.
*
* @param i The index (into the injected routing list) of the route to remove.
* @param network The Network to inject
* @param networkMask The Network Mask to inject
* @param network The Network to withdraw
* @param networkMask The Network Mask to withdraw
* @return whether the operation succeeded (will return false if no such route)
*
* @see GlobalRouter::RemoveInjectedRoute ()

View File

@@ -209,7 +209,7 @@ public:
/**
* \brief Get a metric for route from the static unicast routing table.
*
* \param i The index (into the routing table) of the route to retrieve.
* \param index The index (into the routing table) of the route to retrieve.
* \return If route is set, the metric is returned. If not, an infinity metric (0xffffffff) is returned
*
*/