get rid of some doxygen warnings
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Thu, 02 Jul 2009 16:38:53 +0200
changeset 4645 d53223aae797
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
--- a/src/applications/udp-echo/udp-echo-client.h	Thu Jul 02 16:33:35 2009 +0200
+++ b/src/applications/udp-echo/udp-echo-client.h	Thu Jul 02 16:38:53 2009 +0200
@@ -51,7 +51,7 @@
    * to the server).  The contents of the data are set to unspecified (don't
    * care) by this call.
    *
-   * \warn If you have set the fill data for the echo client using one of the
+   * \warning If you have set the fill data for the echo client using one of the
    * SetFill calls, this will undo those effects.
    *
    * \param dataSize The size of the echo data you want to sent.
@@ -61,7 +61,7 @@
   /**
    * Get the number of data bytes that will be sent to the server.
    *
-   * \warn The number of bytes may be modified by calling any one of the 
+   * \warning The number of bytes may be modified by calling any one of the 
    * SetFill methods.  If you have called SetFill, then the number of 
    * data bytes will correspond to the size of an initialized data buffer.
    * If you have not called a SetFill method, the number of data bytes will
@@ -75,7 +75,7 @@
    * Set the data fill of the packet (what is sent as data to the server) to 
    * the zero-terminated contents of the fill string string.
    *
-   * \warn The size of resulting echo packets will be automatically adjusted
+   * \warning The size of resulting echo packets will be automatically adjusted
    * to reflect the size of the fill string -- this means that the PacketSize
    * attribute may be changed as a result of this call.
    *
@@ -88,7 +88,7 @@
    * the repeated contents of the fill byte.  i.e., the fill byte will be 
    * used to initialize the contents of the data packet.
    * 
-   * \warn The size of resulting echo packets will be automatically adjusted
+   * \warning The size of resulting echo packets will be automatically adjusted
    * to reflect the dataSize parameter -- this means that the PacketSize
    * attribute may be changed as a result of this call.
    *
@@ -105,7 +105,7 @@
    * accomplished by setting the fillSize set to your desired dataSize
    * (and providing an appropriate buffer).
    *
-   * \warn The size of resulting echo packets will be automatically adjusted
+   * \warning The size of resulting echo packets will be automatically adjusted
    * to reflect the dataSize parameter -- this means that the PacketSize
    * attribute of the Application may be changed as a result of this call.
    *
--- a/src/common/pcap-writer.h	Thu Jul 02 16:33:35 2009 +0200
+++ b/src/common/pcap-writer.h	Thu Jul 02 16:38:53 2009 +0200
@@ -118,7 +118,7 @@
    * on a nearby channel.
    * @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 isPreambleShort true if short preamble is used, false otherwise
+   * @param isShortPreamble true if short preamble is used, false otherwise
    * @param isTx true if packet is being transmitted, false when
    * packet is being received
    * @param signalDbm signal power in dBm
--- a/src/devices/wifi/wifi-phy.h	Thu Jul 02 16:33:35 2009 +0200
+++ b/src/devices/wifi/wifi-phy.h	Thu Jul 02 16:38:53 2009 +0200
@@ -309,7 +309,7 @@
    * on a nearby channel.
    * @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 isPreambleShort true if short preamble is used, false otherwise
+   * @param isShortPreamble true if short preamble is used, false otherwise
    * @param signalDbm signal power in dBm
    * @param noiseDbm  noise power in dBm
    */
@@ -331,7 +331,7 @@
    * on a nearby channel.
    * @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 isPreambleShort true if short preamble is used, false otherwise
+   * @param isShortPreamble true if short preamble is used, false otherwise
    */
   void NotifyPromiscSniffTx (Ptr<const Packet> packet, uint16_t channelFreqMhz, uint32_t rate, bool isShortPreamble);