Fix some doxygen warnings revealed by WARN_NO_PARAMDOC=YES in doc/doxygen.conf.

This commit is contained in:
Sebastien Vincent
2009-09-18 22:18:06 +02:00
parent fac12d7448
commit 9f16bba32e
30 changed files with 87 additions and 12 deletions

View File

@@ -78,6 +78,7 @@ public:
* Construct a data rate from an integer. This class only supports positive
* integer data rates in units of bits/s, meaning 1bit/s is the smallest
* non-trivial bitrate availiable.
* \param bps bit/s value
*/
DataRate (uint64_t bps);
DataRate (std::string rate);

View File

@@ -77,6 +77,7 @@ public:
*/
virtual uint32_t Deserialize (Buffer::Iterator start) = 0;
/**
* \param os output stream
* This method is used by Packet::Print to print the
* content of a trailer as ascii data to a c++ output stream.
* Although the trailer is free to format its output as it

View File

@@ -79,6 +79,7 @@ public:
*/
virtual uint32_t Deserialize (Buffer::Iterator end) = 0;
/**
* \param os output stream
* This method is used by Packet::Print to print the
* content of a trailer as ascii data to a c++ output stream.
* Although the trailer is free to format its output as it

View File

@@ -140,6 +140,7 @@ Ptr<T> Create (T1 a1, T2 a2, T3 a3, T4 a4, T5 a5, T6 a6, T7 a7);
/**
* \relates Ptr
* \param p smart pointer
* \return the pointer managed by this smart pointer.
*
* The underlying refcount is not incremented prior
@@ -151,6 +152,7 @@ T * PeekPointer (const Ptr<T> &p);
/**
* \relates Ptr
* \param p smart pointer
* \return the pointer managed by this smart pointer.
*
* The underlying refcount is incremented prior

View File

@@ -61,6 +61,7 @@ public:
/**
* Set the value of the underlying condition.
* \param condition value
*/
void SetCondition (bool condition);
@@ -91,6 +92,7 @@ public:
/**
* Wait a maximum of ns nanoseconds for the condition to be true. If the
* wait times out, return true else return false.
* \param ns maximum of nanoseconds to wait
*/
bool TimedWait (uint64_t ns);

View File

@@ -84,6 +84,8 @@ public:
* method provided to do this is Join (). If you call Join() you will block
* until the SystemThread run method returns.
*
* @param callback entry point of the thread
*
* @warning The SystemThread uses SIGALRM to wake threads that are possibly
* blocked on IO.
* @see Shutdown

View File

@@ -656,6 +656,7 @@ public:
* around so we need to save it. Since file streams are not designed to be
* copied or assigned (what does it mean to have duplicate streams to a file)
* we have to stash a pointer to the stream.
* \param ofs output file stream
*/
void SetStream (std::ofstream *ofs);
@@ -840,6 +841,7 @@ public:
* around so we need to save it. Since file streams are not designed to be
* copied or assigned (what does it mean to have duplicate streams to a file)
* we have to stash a pointer to the stream.
* \param ofs output file stream
*/
void SetStream (std::ofstream *ofs);

View File

@@ -70,12 +70,14 @@ public:
BridgeNetDevice ();
virtual ~BridgeNetDevice ();
/** \brief Add a 'port' to a bridge device
/**
* \brief Add a 'port' to a bridge device
*
* This method adds a new bridge port to a BridgeNetDevice, so that
* the new bridge port NetDevice becomes part of the bridge and L2
* frames start being forwarded to/from this NetDevice.
*
* \param bridgePort NetDevice
* \attention The netdevice that is being added as bridge port must
* _not_ have an IP address. In order to add IP connectivity to a
* bridging node you must enable IP on the BridgeNetDevice itself,

View File

@@ -349,12 +349,21 @@ public:
/**
* Start sending a packet down the channel.
* \param packet packet to send
* \param dest layer 2 destination address
* \param protocolNumber protocol number
* \return true if successfull, false otherwise (drop, ...)
*/
virtual bool Send (Ptr<Packet> packet, const Address& dest,
uint16_t protocolNumber);
/**
* Start sending a packet down the channel, with MAC spoofing
* \param packet packet to send
* \param source layer 2 source address
* \param dest layer 2 destination address
* \param protocolNumber protocol number
* \return true if successfull, false otherwise (drop, ...)
*/
virtual bool SendFrom (Ptr<Packet> packet, const Address& source, const Address& dest,
uint16_t protocolNumber);
@@ -448,30 +457,35 @@ private:
/**
* Operator = is declared but not implemented. This disables the assigment
* operator for CsmaNetDevice objects.
* \param o object to copy
*/
CsmaNetDevice &operator = (const CsmaNetDevice &o);
/**
* Copy constructor is declared but not implemented. This disables the
* copy constructor for CsmaNetDevice objects.
* \param o object to copy
*/
CsmaNetDevice (const CsmaNetDevice &o);
/**
* Initialization function used during object construction.
* \param sendEnable if device will be allowed to send
* \param receiveEnable if device will be allowed to receive
*/
void Init (bool sendEnable, bool receiveEnable);
/**
* Calculate the value for the MTU that would result from
* setting the frame size to the given value.
* \param frameSize size of frame
*/
uint32_t MtuFromFrameSize (uint32_t frameSize);
/**
* Calculate the value for the frame size that would be required
* to be able to set the MTU to the given value.
* \param mtu MTU
*/
uint32_t FrameSizeFromMtu (uint32_t mtu);

View File

@@ -225,12 +225,16 @@ private:
/**
* Adds the necessary headers and trailers to a packet of data in order to
* respect the protocol implemented by the agent.
* \param p packet
* \param protocolNumber protocol number
*/
void AddHeader(Ptr<Packet> p, uint16_t protocolNumber);
void AddHeader (Ptr<Packet> p, uint16_t protocolNumber);
/**
* Removes, from a packet of data, all headers and trailers that
* relate to the protocol implemented by the agent
* \param p Packet whose headers need to be processed
* \param param An integer parameter that can be set by the function
* \return Returns true if the packet should be forwarded up the
* protocol stack.
*/
@@ -238,7 +242,7 @@ private:
/**
* Start Sending a Packet Down the Wire.
*
* @param p packet to send
* @returns true if success, false on failure
*/
bool TransmitStart (Ptr<Packet> p);

View File

@@ -275,12 +275,14 @@ private:
/**
* Calculate the value for the MTU that would result from
* setting the frame size to the given value.
* \param frameSize size of frame
*/
uint32_t MtuFromFrameSize (uint32_t frameSize);
/**
* Calculate the value for the frame size that would be required
* to be able to set the MTU to the given value.
* \param mtu MTU
*/
uint32_t FrameSizeFromMtu (uint32_t mtu);
@@ -293,12 +295,16 @@ private:
/**
* Adds the necessary headers and trailers to a packet of data in order to
* respect the protocol implemented by the agent.
* \param p packet
* \param protocolNumber protocol number
*/
void AddHeader(Ptr<Packet> p, uint16_t protocolNumber);
/**
* Removes, from a packet of data, all headers and trailers that
* relate to the protocol implemented by the agent
* \param p Packet whose headers need to be processed
* \param param An integer parameter that can be set by the function
* \return Returns true if the packet should be forwarded up the
* protocol stack.
*/

View File

@@ -113,7 +113,8 @@ public:
TapBridge ();
virtual ~TapBridge ();
/** \brief Get the bridged net device.
/**
* \brief Get the bridged net device.
*
* The bridged net device is the ns-3 device to which this bridge is connected,
*
@@ -121,10 +122,13 @@ public:
*/
Ptr<NetDevice> GetBridgedNetDevice (void);
/** \brief Set the ns-3 net device to bridge.
/**
* \brief Set the ns-3 net device to bridge.
*
* This method tells the bridge which ns-3 net device it should use to connect
* the simulation side of the bridge.
* the simulation side of the bridge.
*
* \param bridgedDevice device to set
*
* \attention The ns-3 net device that is being set as the device must have an
* an IP address assigned to it before the simulation is run. This address

View File

@@ -93,6 +93,7 @@ public:
/**
* \brief Configure the reported MTU for the virtual device. The
* default value is 65535.
* \param mtu MTU value to set
* \return whether the MTU value was within legal bounds
*/
bool SetMtu (const uint16_t mtu);

View File

@@ -22,6 +22,7 @@ public:
/**
* Concatenate the entries in the other container with ours.
* \param other container
*/
void Add (Ipv4InterfaceContainer other);
@@ -31,6 +32,8 @@ public:
uint32_t GetN (void) const;
/**
* \param i interface index
* \param j interface address index (if interface has multiple addresses)
* \returns the IPv4 address of the j'th address of the interface
* corresponding to index i.
*

View File

@@ -67,6 +67,8 @@ public:
*
* Functionally equivalent to:
* route add 224.0.0.0 netmask 240.0.0.0 dev nd
* \param n node
* \param nd device of the node to add default route
*/
void SetDefaultMulticastRoute (Ptr<Node> n, Ptr<NetDevice> nd);
void SetDefaultMulticastRoute (Ptr<Node> n, std::string ndName);

View File

@@ -129,6 +129,12 @@ public:
* packet is coming to:
* - implement a per-NetDevice ARP cache
* - send back arp replies on the right device
* \param device network device
* \param p the packet
* \param protocol protocol value
* \param from address of the correspondant
* \param to address of the destination
* \param packetType type of the packet
*/
void Receive( Ptr<NetDevice> device, Ptr<const Packet> p, uint16_t protocol, const Address &from,
const Address &to, NetDevice::PacketType packetType);

View File

@@ -80,6 +80,7 @@ public:
* already existed a child model, then the child mobility model
* current position is also modified to ensure that the composite
* position is preserved.
* \param model new mobility model child
*/
void SetChild (Ptr<MobilityModel> model);
/**
@@ -87,6 +88,7 @@ public:
* already existed a child model, then the child mobility model
* current position is also modified to ensure that the composite
* position is preserved.
* \param model new mobility model parent
*/
void SetParent (Ptr<MobilityModel> model);

View File

@@ -87,6 +87,7 @@ public:
void SetIpv4 (Ipv4Address address);
/**
* \param address address to test
* \returns true if the address matches, false otherwise.
*/
static bool IsMatchingType (const Address &address);

View File

@@ -210,7 +210,7 @@ public:
*/
Ipv4Mask ();
/**
* param mask bitwise integer representation of the mask
* \param mask bitwise integer representation of the mask
*
* For example, the integer input 0xffffff00 yields a 24-bit mask
*/

View File

@@ -78,6 +78,7 @@ public:
*/
static Mac48Address ConvertFrom (const Address &address);
/**
* \param address address to test
* \returns true if the address matches, false otherwise.
*/
static bool IsMatchingType (const Address &address);
@@ -102,12 +103,14 @@ public:
static Mac48Address GetBroadcast (void);
/**
* \param address base IPv4 address
* \returns a multicast address
*/
static Mac48Address GetMulticast (Ipv4Address address);
/**
* \brief Get multicast address from IPv6 address.
* \param address base IPv6 address
* \returns a multicast address
*/
static Mac48Address GetMulticast (Ipv6Address address);

View File

@@ -73,6 +73,7 @@ public:
*/
static Mac64Address ConvertFrom (const Address &address);
/**
* \param address address to test
* \returns true if the address matches, false otherwise.
*/
static bool IsMatchingType (const Address &address);

View File

@@ -99,6 +99,7 @@ public:
/**
* Set the address of this interface
* \param address address to set
*/
virtual void SetAddress (Address address) = 0;

View File

@@ -64,6 +64,7 @@ class PacketSocketAddress
*/
static PacketSocketAddress ConvertFrom (const Address &address);
/**
* \param address address to test
* \returns true if the address matches, false otherwise.
*/
static bool IsMatchingType (const Address &address);

View File

@@ -609,6 +609,7 @@ public:
/**
* \brief Deserializes a packet from the specified buffer.
* \param start start offset
* \return the number of bytes deserialized
*
* If this returns a number smaller than the total number of bytes in the

View File

@@ -56,6 +56,7 @@ public:
bool IsEmpty (void) const;
/**
* Place a packet into the rear of the Queue
* \param p packet to enqueue
* \return True if the operation was successful; false otherwise
*/
bool Enqueue (Ptr<Packet> p);

View File

@@ -487,8 +487,9 @@ public:
*/
int RecvFrom (uint8_t* buf, uint32_t size, uint32_t flags,
Address &fromAddress);
/**
* \returns the address name this socket is associated with.
/**
* \param address the address name this socket is associated with.
* \returns 0 if success, -1 otherwise
*/
virtual int GetSockName (Address &address) const = 0;

View File

@@ -167,6 +167,7 @@ private:
* Candidate Queue copy construction is disallowed (not implemented) to
* prevent the compiler from slipping in incorrect versions that don't
* properly deal with deep copies.
* \param sr object to copy
*/
CandidateQueue (CandidateQueue& sr);
@@ -174,6 +175,7 @@ private:
* Candidate Queue assignment operator is disallowed (not implemented) to
* prevent the compiler from slipping in incorrect versions that don't
* properly deal with deep copies.
* \param sr object to assign
*/
CandidateQueue& operator= (CandidateQueue& sr);

View File

@@ -401,7 +401,7 @@ public:
/**
* @brief Set the Link State ID is defined by the OSPF spec. We always set it
* to the router ID of the router making the advertisement.
*
* @param addr IPv4 address which will act as ID
* @see RoutingEnvironment::AllocateRouterId ()
* @see GlobalRouting::GetRouterId ()
*/
@@ -421,6 +421,7 @@ public:
* @brief Set the Advertising Router as defined by the OSPF spec. We always
* set it to the router ID of the router making the advertisement.
*
* @param rtr ID of the router making advertisement
* @see RoutingEnvironment::AllocateRouterId ()
* @see GlobalRouting::GetRouterId ()
*/
@@ -473,7 +474,7 @@ public:
/**
* @brief Set the SPF status of the advertisement
*
* @param status SPF status to set
* @see SPFStatus
*/
void SetStatus (SPFStatus status);

View File

@@ -193,6 +193,7 @@ public:
*/
uint32_t GetNOutputInterfaces (void) const;
/**
* \param n interface index
* \return A specified output interface.
*/
uint32_t GetOutputInterface (uint32_t n) const;

View File

@@ -535,6 +535,7 @@ std::istream& operator>> (std::istream& is, Time & time);
* Time t = Seconds (2.0);
* Simulator::Schedule (NanoSeconds (5.0), ...);
* \endcode
* \param seconds seconds value
*/
Time Seconds (double seconds);
@@ -546,6 +547,7 @@ Time Seconds (double seconds);
* Time t = MilliSeconds (2);
* Simulator::Schedule (MilliSeconds (5), ...);
* \endcode
* \param ms milliseconds value
*/
Time MilliSeconds (uint64_t ms);
/**
@@ -556,6 +558,7 @@ Time MilliSeconds (uint64_t ms);
* Time t = MicroSeconds (2);
* Simulator::Schedule (MicroSeconds (5), ...);
* \endcode
* \param us microseconds value
*/
Time MicroSeconds (uint64_t us);
/**
@@ -566,6 +569,7 @@ Time MicroSeconds (uint64_t us);
* Time t = NanoSeconds (2);
* Simulator::Schedule (NanoSeconds (5), ...);
* \endcode
* \param ns nanoseconds value
*/
Time NanoSeconds (uint64_t ns);
/**
@@ -576,6 +580,7 @@ Time NanoSeconds (uint64_t ns);
* Time t = PicoSeconds (2);
* Simulator::Schedule (PicoSeconds (5), ...);
* \endcode
* \param ps picoseconds value
*/
Time PicoSeconds (uint64_t ps);
/**
@@ -586,6 +591,7 @@ Time PicoSeconds (uint64_t ps);
* Time t = FemtoSeconds (2);
* Simulator::Schedule (FemtoSeconds (5), ...);
* \endcode
* \param fs femtoseconds value
*/
Time FemtoSeconds (uint64_t fs);