get rid of some doxygen warnings
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Thu, 02 Jul 2009 16:38:53 +0200
changeset 4645d53223aae797
parent 4644 846d7a49f4b7
child 4646 c25ca2e38845
get rid of some doxygen warnings
src/applications/udp-echo/udp-echo-client.h
src/common/pcap-writer.h
src/devices/wifi/wifi-phy.h
     1.1 --- a/src/applications/udp-echo/udp-echo-client.h	Thu Jul 02 16:33:35 2009 +0200
     1.2 +++ b/src/applications/udp-echo/udp-echo-client.h	Thu Jul 02 16:38:53 2009 +0200
     1.3 @@ -51,7 +51,7 @@
     1.4     * to the server).  The contents of the data are set to unspecified (don't
     1.5     * care) by this call.
     1.6     *
     1.7 -   * \warn If you have set the fill data for the echo client using one of the
     1.8 +   * \warning If you have set the fill data for the echo client using one of the
     1.9     * SetFill calls, this will undo those effects.
    1.10     *
    1.11     * \param dataSize The size of the echo data you want to sent.
    1.12 @@ -61,7 +61,7 @@
    1.13    /**
    1.14     * Get the number of data bytes that will be sent to the server.
    1.15     *
    1.16 -   * \warn The number of bytes may be modified by calling any one of the 
    1.17 +   * \warning The number of bytes may be modified by calling any one of the 
    1.18     * SetFill methods.  If you have called SetFill, then the number of 
    1.19     * data bytes will correspond to the size of an initialized data buffer.
    1.20     * If you have not called a SetFill method, the number of data bytes will
    1.21 @@ -75,7 +75,7 @@
    1.22     * Set the data fill of the packet (what is sent as data to the server) to 
    1.23     * the zero-terminated contents of the fill string string.
    1.24     *
    1.25 -   * \warn The size of resulting echo packets will be automatically adjusted
    1.26 +   * \warning The size of resulting echo packets will be automatically adjusted
    1.27     * to reflect the size of the fill string -- this means that the PacketSize
    1.28     * attribute may be changed as a result of this call.
    1.29     *
    1.30 @@ -88,7 +88,7 @@
    1.31     * the repeated contents of the fill byte.  i.e., the fill byte will be 
    1.32     * used to initialize the contents of the data packet.
    1.33     * 
    1.34 -   * \warn The size of resulting echo packets will be automatically adjusted
    1.35 +   * \warning The size of resulting echo packets will be automatically adjusted
    1.36     * to reflect the dataSize parameter -- this means that the PacketSize
    1.37     * attribute may be changed as a result of this call.
    1.38     *
    1.39 @@ -105,7 +105,7 @@
    1.40     * accomplished by setting the fillSize set to your desired dataSize
    1.41     * (and providing an appropriate buffer).
    1.42     *
    1.43 -   * \warn The size of resulting echo packets will be automatically adjusted
    1.44 +   * \warning The size of resulting echo packets will be automatically adjusted
    1.45     * to reflect the dataSize parameter -- this means that the PacketSize
    1.46     * attribute of the Application may be changed as a result of this call.
    1.47     *
     2.1 --- a/src/common/pcap-writer.h	Thu Jul 02 16:33:35 2009 +0200
     2.2 +++ b/src/common/pcap-writer.h	Thu Jul 02 16:38:53 2009 +0200
     2.3 @@ -118,7 +118,7 @@
     2.4     * on a nearby channel.
     2.5     * @param rate the PHY data rate in units of 500kbps (i.e., the same
     2.6     * units used both for the radiotap and for the prism header) 
     2.7 -   * @param isPreambleShort true if short preamble is used, false otherwise
     2.8 +   * @param isShortPreamble true if short preamble is used, false otherwise
     2.9     * @param isTx true if packet is being transmitted, false when
    2.10     * packet is being received
    2.11     * @param signalDbm signal power in dBm
     3.1 --- a/src/devices/wifi/wifi-phy.h	Thu Jul 02 16:33:35 2009 +0200
     3.2 +++ b/src/devices/wifi/wifi-phy.h	Thu Jul 02 16:38:53 2009 +0200
     3.3 @@ -309,7 +309,7 @@
     3.4     * on a nearby channel.
     3.5     * @param rate the PHY data rate in units of 500kbps (i.e., the same
     3.6     * units used both for the radiotap and for the prism header) 
     3.7 -   * @param isPreambleShort true if short preamble is used, false otherwise
     3.8 +   * @param isShortPreamble true if short preamble is used, false otherwise
     3.9     * @param signalDbm signal power in dBm
    3.10     * @param noiseDbm  noise power in dBm
    3.11     */
    3.12 @@ -331,7 +331,7 @@
    3.13     * on a nearby channel.
    3.14     * @param rate the PHY data rate in units of 500kbps (i.e., the same
    3.15     * units used both for the radiotap and for the prism header) 
    3.16 -   * @param isPreambleShort true if short preamble is used, false otherwise
    3.17 +   * @param isShortPreamble true if short preamble is used, false otherwise
    3.18     */
    3.19    void NotifyPromiscSniffTx (Ptr<const Packet> packet, uint16_t channelFreqMhz, uint32_t rate, bool isShortPreamble);
    3.20