Fix doxygen errors
authorTom Henderson <tomh@tomh.org>
Fri Sep 04 18:02:03 2009 -0700 (5 months ago)
changeset 47571b7c28a1c131
parent 4756 4103e20ef21b
child 4758 0f9bcd407aff
Fix doxygen errors
src/devices/wifi/wifi-mode.h
src/devices/wifi/wifi-phy.h
src/routing/global-routing/global-router-interface.h
src/routing/static-routing/ipv4-static-routing.h
     1.1 --- a/src/devices/wifi/wifi-mode.h	Fri Sep 04 17:33:08 2009 -0700
     1.2 +++ b/src/devices/wifi/wifi-mode.h	Fri Sep 04 18:02:03 2009 -0700
     1.3 @@ -151,6 +151,7 @@
     1.4     *        associated WifiMode is used.
     1.5     * \param dataRate the rate (bits/second) at which the user data is transmitted
     1.6     * \param phyRate the rate (bits/second) at which the encoded user data is transmitted
     1.7 +   * \param standard the Wifi Phy standard to apply
     1.8     *        The phyRate includes FEC so, is typically higher than the dataRate.
     1.9     *
    1.10     * Create a BPSK WifiMode.
    1.11 @@ -171,6 +172,7 @@
    1.12     * \param phyRate the rate (bits/second) at which the encoded user data is transmitted
    1.13     *        The phyRate includes FEC so, is typically higher than the dataRate.
    1.14     * \param constellationSize the number of elements included in the QAM constellation. 
    1.15 +   * \param standard the Wifi Phy standard to apply
    1.16     *
    1.17     * Create a QAM WifiMode.
    1.18     */
    1.19 @@ -190,6 +192,7 @@
    1.20     *        associated WifiMode is used.
    1.21     * \param dataRate the rate (bits/second) at which the user data is transmitted
    1.22     * \param phyRate the rate (bits/second) at which the encoded user data is transmitted
    1.23 +   * \param standard the Wifi Phy standard to apply
    1.24     *        The phyRate includes FEC so, is typically higher than the dataRate.
    1.25     *
    1.26     * Create a DBPSK WifiMode.
    1.27 @@ -208,6 +211,7 @@
    1.28     *        associated WifiMode is used.
    1.29     * \param dataRate the rate (bits/second) at which the user data is transmitted
    1.30     * \param phyRate the rate (bits/second) at which the encoded user data is transmitted
    1.31 +   * \param standard the Wifi Phy standard to apply
    1.32     *        The phyRate includes FEC so, is typically higher than the dataRate.
    1.33     *
    1.34     * Create a DQPSK WifiMode.
     2.1 --- a/src/devices/wifi/wifi-phy.h	Fri Sep 04 17:33:08 2009 -0700
     2.2 +++ b/src/devices/wifi/wifi-phy.h	Fri Sep 04 18:02:03 2009 -0700
     2.3 @@ -337,6 +337,7 @@
     2.4     * transmitted. This is because it is possible to have the receiver
     2.5     * tuned on a given channel and still to be able to receive packets
     2.6     * on a nearby channel.
     2.7 +   * @param channelNumber the channel on which the packet is received
     2.8     * @param rate the PHY data rate in units of 500kbps (i.e., the same
     2.9     * units used both for the radiotap and for the prism header) 
    2.10     * @param isShortPreamble true if short preamble is used, false otherwise
    2.11 @@ -351,14 +352,10 @@
    2.12     * Public method used to fire a PromiscSniffer trace for a wifi packet being transmitted.  Implemented for encapsulation 
    2.13     * purposes.
    2.14     * 
    2.15 -   * @param packet the packet being received
    2.16 +   * @param packet the packet being transmitted
    2.17     * @param channelFreqMhz the frequency in MHz at which the packet is
    2.18 -   * received. Note that in real devices this is normally the
    2.19 -   * frequency to which  the receiver is tuned, and this can be
    2.20 -   * different than the frequency at which the packet was originally
    2.21 -   * transmitted. This is because it is possible to have the receiver
    2.22 -   * tuned on a given channel and still to be able to receive packets
    2.23 -   * on a nearby channel.
    2.24 +   * transmitted. 
    2.25 +   * @param channelNumber the channel on which the packet is transmitted
    2.26     * @param rate the PHY data rate in units of 500kbps (i.e., the same
    2.27     * units used both for the radiotap and for the prism header) 
    2.28     * @param isShortPreamble true if short preamble is used, false otherwise
     3.1 --- a/src/routing/global-routing/global-router-interface.h	Fri Sep 04 17:33:08 2009 -0700
     3.2 +++ b/src/routing/global-routing/global-router-interface.h	Fri Sep 04 18:02:03 2009 -0700
     3.3 @@ -615,8 +615,6 @@
     3.4   * advertisements after a network topology change by calling DiscoverLSAs 
     3.5   * and then by reading those advertisements.
     3.6   *
     3.7 - * \param List of routing table entries of external routes to be injected.
     3.8 - *
     3.9   * @see GlobalRoutingLSA
    3.10   * @see GlobalRouter::GetLSA ()
    3.11   * @returns The number of Global Routing Link State Advertisements.
    3.12 @@ -700,13 +698,8 @@
    3.13  /**
    3.14   * @brief Withdraw a route from the global unicast routing table.
    3.15   *
    3.16 - * Calling this function will cause all indexed routes numbered above
    3.17 - * index i to have their index decremented.  For instance, it is possible to
    3.18 - * remove N injected routes by calling RemoveInjectedRoute (0) N times.
    3.19 - *
    3.20 - * @param i The index (into the injected routing list) of the route to remove.  
    3.21 - * @param network The Network to inject
    3.22 - * @param networkMask The Network Mask to inject
    3.23 + * @param network The Network to withdraw
    3.24 + * @param networkMask The Network Mask to withdraw
    3.25   * @return whether the operation succeeded (will return false if no such route)
    3.26   *
    3.27   * @see GlobalRouter::RemoveInjectedRoute ()
     4.1 --- a/src/routing/static-routing/ipv4-static-routing.h	Fri Sep 04 17:33:08 2009 -0700
     4.2 +++ b/src/routing/static-routing/ipv4-static-routing.h	Fri Sep 04 18:02:03 2009 -0700
     4.3 @@ -209,7 +209,7 @@
     4.4  /**
     4.5   * \brief Get a metric for route from the static unicast routing table.
     4.6   *
     4.7 - * \param i The index (into the routing table) of the route to retrieve.  
     4.8 + * \param index The index (into the routing table) of the route to retrieve.  
     4.9   * \return If route is set, the metric is returned. If not, an infinity metric (0xffffffff) is returned
    4.10   *
    4.11   */