Doxygen cleanup

This commit is contained in:
Tom Henderson
2007-08-13 20:53:29 -07:00
parent 915e34b32b
commit ad3b6a04cc
5 changed files with 17 additions and 5 deletions

View File

@@ -97,7 +97,7 @@ public:
* \param n1 Node
* \param ndNum NetDevice number with which to associate address
* \param addr1 Ipv4 Address for ndNum of n1
* \param network network mask for ndNum of node n1
* \param netmask1 network mask for ndNum of node n1
*
* Add an Ipv4Address to the Ipv4 interface associated with the
* ndNum CsmaIpv4NetDevices on the provided

View File

@@ -99,8 +99,23 @@ enum CsmaEncapsulationMode {
*
* \param node the Node to which this device is connected.
* \param addr The source MAC address of the net device.
* \param pktType the type of encapsulation
*/
CsmaNetDevice (Ptr<Node> node, Eui48Address addr, CsmaEncapsulationMode pktType);
/**
* Construct a CsmaNetDevice
*
* This is the constructor for the CsmaNetDevice. It takes as a
* parameter the Node to which this device is connected. Ownership of the
* Node pointer is not implied and the node must not be deleted.
*
* \param node the Node to which this device is connected.
* \param addr The source MAC address of the net device.
* \param pktType the type of encapsulation
* \param sendEnable whether this device is able to send
* \param receiveEnable whether this device is able to receive
*/
CsmaNetDevice (Ptr<Node> node, Eui48Address addr,
CsmaEncapsulationMode pktType,
bool sendEnable, bool receiveEnable);

View File

@@ -175,7 +175,6 @@ protected:
virtual Ptr<Channel> DoGetChannel(void) const;
/**
* Set a new default data rate
* @param Data rate to set for new default
*/
static void SetDefaultRate(const DataRate&);

View File

@@ -170,7 +170,6 @@ public:
/**
* \brief Send data (or dummy data) to the remote host
* \param p packet to send
* \param dataSent Data sent callback.
* \returns -1 in case of error or the number of bytes copied in the
* internal buffer and accepted for transmission.
*/
@@ -180,7 +179,6 @@ public:
* \brief Send data to a specified peer.
* \param address IP Address of remote host
* \param p packet to send
* \param dataSent Data sent callback.
* \returns -1 in case of error or the number of bytes copied in the
* internal buffer and accepted for transmission.
*/

View File

@@ -431,7 +431,7 @@ public:
/**
* @brief Add an attached router to the list in the NetworkLSA
*
* @param address The Ipv4Address of the interface on the network link
* @param addr The Ipv4Address of the interface on the network link
* @returns The number of addresses in the list.
*/
uint32_t AddAttachedRouter (Ipv4Address addr);