fix some Doxygen warnings

This commit is contained in:
Tom Henderson
2008-09-15 06:10:53 -07:00
parent 8e3cdc2e0c
commit b005d33fb9
5 changed files with 19 additions and 7 deletions

View File

@@ -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.

View File

@@ -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;
/**

View File

@@ -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);
/**

View File

@@ -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
};

View File

@@ -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;