From b005d33fb926597c241dbd47a2a84ceedbd45660 Mon Sep 17 00:00:00 2001
From: Tom Henderson <tomh@tomh.org>
Date: Mon, 15 Sep 2008 06:10:53 -0700
Subject: [PATCH] fix some Doxygen warnings

---
 src/devices/csma/csma-net-device.h |  1 +
 src/devices/wifi/wifi-mac.h        | 13 ++++++++++++-
 src/internet-stack/arp-cache.h     |  2 +-
 src/node/address.h                 |  8 ++++----
 src/node/net-device.h              |  2 +-
 5 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/src/devices/csma/csma-net-device.h b/src/devices/csma/csma-net-device.h
index 08f25cae5..f239c4a32 100644
--- a/src/devices/csma/csma-net-device.h
+++ b/src/devices/csma/csma-net-device.h
@@ -419,6 +419,7 @@ protected:
    * 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.
diff --git a/src/devices/wifi/wifi-mac.h b/src/devices/wifi/wifi-mac.h
index 0f18dc9f7..47a4f6076 100644
--- a/src/devices/wifi/wifi-mac.h
+++ b/src/devices/wifi/wifi-mac.h
@@ -132,6 +132,18 @@ public:
 
 private:
   friend class WifiNetDevice;
+  /**
+   * \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.
@@ -140,7 +152,6 @@ private:
    * 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;
   /**
diff --git a/src/internet-stack/arp-cache.h b/src/internet-stack/arp-cache.h
index b143b4e0a..a161b898e 100644
--- a/src/internet-stack/arp-cache.h
+++ b/src/internet-stack/arp-cache.h
@@ -156,7 +156,7 @@ public:
      */
     Ipv4Address GetIpv4Address (void) const;
     /**
-     * \param The Ipv4Address for this entry
+     * \param destination The Ipv4Address for this entry
      */
     void SetIpv4Address (Ipv4Address destination);
     /**
diff --git a/src/node/address.h b/src/node/address.h
index b53c6bb6f..b6921ff09 100644
--- a/src/node/address.h
+++ b/src/node/address.h
@@ -66,11 +66,11 @@ namespace ns3 {
 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
   };
 
diff --git a/src/node/net-device.h b/src/node/net-device.h
index 3a34ddfe8..35c81f4f0 100644
--- a/src/node/net-device.h
+++ b/src/node/net-device.h
@@ -312,7 +312,7 @@ public:
   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;