fix some Doxygen warnings
authorTom Henderson <tomh@tomh.org>
Mon, 15 Sep 2008 06:10:53 -0700
changeset 3698 3251aa0de5c8
parent 3695 a60aeddab0fe
child 3699 29473501ade8
fix some Doxygen warnings
src/devices/csma/csma-net-device.h
src/devices/wifi/wifi-mac.h
src/internet-stack/arp-cache.h
src/node/address.h
src/node/net-device.h
--- a/src/devices/csma/csma-net-device.h	Sun Sep 14 17:55:30 2008 -0700
+++ b/src/devices/csma/csma-net-device.h	Mon Sep 15 06:10:53 2008 -0700
@@ -419,6 +419,7 @@
    * respect the packet type
    *
    * \param p Packet to which header should be added
+   * \param source MAC source address from which packet should be sent
    * \param dest MAC destination address to which packet should be sent
    * \param protocolNumber In some protocols, identifies the type of
    * payload contained in this packet.
--- a/src/devices/wifi/wifi-mac.h	Sun Sep 14 17:55:30 2008 -0700
+++ b/src/devices/wifi/wifi-mac.h	Mon Sep 15 06:10:53 2008 -0700
@@ -135,12 +135,23 @@
   /**
    * \param packet the packet to send.
    * \param to the address to which the packet should be sent.
+   * \param from the address from which the packet should be sent.
+   *
+   * The packet should be enqueued in a tx queue, and should be
+   * dequeued as soon as the DCF function determines that
+   * access it granted to this MAC.  The extra parameter "from" allows
+   * this device to operate in a bridged mode, forwarding received
+   * frames without altering the source addresss.
+   */
+  virtual void Enqueue (Ptr<const Packet> packet, Mac48Address to, Mac48Address from) = 0;
+  /**
+   * \param packet the packet to send.
+   * \param to the address to which the packet should be sent.
    *
    * The packet should be enqueued in a tx queue, and should be
    * dequeued as soon as the DCF function determines that
    * access it granted to this MAC.
    */
-  virtual void Enqueue (Ptr<const Packet> packet, Mac48Address to, Mac48Address from) = 0;
   virtual void Enqueue (Ptr<const Packet> packet, Mac48Address to) = 0;
   virtual bool SupportsSendFrom (void) const = 0;
   /**
--- a/src/internet-stack/arp-cache.h	Sun Sep 14 17:55:30 2008 -0700
+++ b/src/internet-stack/arp-cache.h	Mon Sep 15 06:10:53 2008 -0700
@@ -156,7 +156,7 @@
      */
     Ipv4Address GetIpv4Address (void) const;
     /**
-     * \param The Ipv4Address for this entry
+     * \param destination The Ipv4Address for this entry
      */
     void SetIpv4Address (Ipv4Address destination);
     /**
--- a/src/node/address.h	Sun Sep 14 17:55:30 2008 -0700
+++ b/src/node/address.h	Mon Sep 15 06:10:53 2008 -0700
@@ -66,11 +66,11 @@
 class Address 
 {
 public:
+  /**
+   * The maximum size of a byte buffer which
+   * can be stored in an Address instance.
+   */
   enum MaxSize_e {
-    /**
-     * The maximum size of a byte buffer which
-     * can be stored in an Address instance.
-     */
     MAX_SIZE = 30
   };
 
--- a/src/node/net-device.h	Sun Sep 14 17:55:30 2008 -0700
+++ b/src/node/net-device.h	Mon Sep 15 06:10:53 2008 -0700
@@ -312,7 +312,7 @@
   virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb) = 0;
 
   /**
-   * \return true if this interface supports a promiscuous mode, false otherwise.
+   * \return true if this interface supports a bridging mode, false otherwise.
    */
   virtual bool SupportsSendFrom (void) const = 0;