Fix some doxygen warnings revealed by WARN_NO_PARAMDOC=YES in doc/doxygen.conf.
authorSebastien Vincent <vincent@clarinet.u-strasbg.fr>
Fri, 18 Sep 2009 22:18:06 +0200
changeset 5227 ecb08c1fc273
parent 5225 9c612cb88d6b
child 5228 016ffb09d8a8
Fix some doxygen warnings revealed by WARN_NO_PARAMDOC=YES in doc/doxygen.conf.
src/common/data-rate.h
src/common/header.h
src/common/trailer.h
src/core/ptr.h
src/core/system-condition.h
src/core/system-thread.h
src/core/test.h
src/devices/bridge/bridge-net-device.h
src/devices/csma/csma-net-device.h
src/devices/emu/emu-net-device.h
src/devices/point-to-point/point-to-point-net-device.h
src/devices/tap-bridge/tap-bridge.h
src/devices/virtual-net-device/virtual-net-device.h
src/helper/ipv4-interface-container.h
src/helper/ipv4-static-routing-helper.h
src/internet-stack/ipv4-l3-protocol.h
src/mobility/hierarchical-mobility-model.h
src/node/inet-socket-address.h
src/node/ipv4-address.h
src/node/mac48-address.h
src/node/mac64-address.h
src/node/net-device.h
src/node/packet-socket-address.h
src/node/packetbb.h
src/node/queue.h
src/node/socket.h
src/routing/global-routing/candidate-queue.h
src/routing/global-routing/global-router-interface.h
src/routing/static-routing/ipv4-routing-table-entry.h
src/simulator/nstime.h
--- a/src/common/data-rate.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/common/data-rate.h	Fri Sep 18 22:18:06 2009 +0200
@@ -78,6 +78,7 @@
    * 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);
--- a/src/common/header.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/common/header.h	Fri Sep 18 22:18:06 2009 +0200
@@ -77,6 +77,7 @@
    */
   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
--- a/src/common/trailer.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/common/trailer.h	Fri Sep 18 22:18:06 2009 +0200
@@ -79,6 +79,7 @@
    */
   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
--- a/src/core/ptr.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/core/ptr.h	Fri Sep 18 22:18:06 2009 +0200
@@ -140,6 +140,7 @@
 
 /**
  * \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 @@
 
 /**
  * \relates Ptr
+ * \param p smart pointer
  * \return the pointer managed by this smart pointer.
  *
  * The underlying refcount is incremented prior
--- a/src/core/system-condition.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/core/system-condition.h	Fri Sep 18 22:18:06 2009 +0200
@@ -61,6 +61,7 @@
 
   /**
    * Set the value of the underlying condition.
+   * \param condition value
    */
   void SetCondition (bool condition);
 
@@ -91,6 +92,7 @@
   /**
    * 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);
 	
--- a/src/core/system-thread.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/core/system-thread.h	Fri Sep 18 22:18:06 2009 +0200
@@ -84,6 +84,8 @@
    * 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
--- a/src/core/test.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/core/test.h	Fri Sep 18 22:18:06 2009 +0200
@@ -656,6 +656,7 @@
    * 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 @@
    * 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);
 
--- a/src/devices/bridge/bridge-net-device.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/devices/bridge/bridge-net-device.h	Fri Sep 18 22:18:06 2009 +0200
@@ -70,12 +70,14 @@
   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,
--- a/src/devices/csma/csma-net-device.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/devices/csma/csma-net-device.h	Fri Sep 18 22:18:06 2009 +0200
@@ -349,12 +349,21 @@
 
   /**
    * 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 @@
   /**
    * 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);
 
--- a/src/devices/emu/emu-net-device.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/devices/emu/emu-net-device.h	Fri Sep 18 22:18:06 2009 +0200
@@ -225,12 +225,16 @@
   /**
    * 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 @@
 
   /**
    * Start Sending a Packet Down the Wire.
-   *
+   * @param p packet to send
    * @returns true if success, false on failure
    */
   bool TransmitStart (Ptr<Packet> p);
--- a/src/devices/point-to-point/point-to-point-net-device.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/devices/point-to-point/point-to-point-net-device.h	Fri Sep 18 22:18:06 2009 +0200
@@ -275,12 +275,14 @@
   /**
    * 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 @@
   /**
    * 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.
    */
--- a/src/devices/tap-bridge/tap-bridge.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/devices/tap-bridge/tap-bridge.h	Fri Sep 18 22:18:06 2009 +0200
@@ -113,7 +113,8 @@
   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 @@
    */
   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 
--- a/src/devices/virtual-net-device/virtual-net-device.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/devices/virtual-net-device/virtual-net-device.h	Fri Sep 18 22:18:06 2009 +0200
@@ -93,6 +93,7 @@
   /**
    * \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);
--- a/src/helper/ipv4-interface-container.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/helper/ipv4-interface-container.h	Fri Sep 18 22:18:06 2009 +0200
@@ -22,6 +22,7 @@
 
   /**
    * Concatenate the entries in the other container with ours.
+   * \param other container
    */
   void Add (Ipv4InterfaceContainer other);
 
@@ -31,6 +32,8 @@
   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.
    * 
--- a/src/helper/ipv4-static-routing-helper.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/helper/ipv4-static-routing-helper.h	Fri Sep 18 22:18:06 2009 +0200
@@ -67,6 +67,8 @@
    *
    * 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);
--- a/src/internet-stack/ipv4-l3-protocol.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/internet-stack/ipv4-l3-protocol.h	Fri Sep 18 22:18:06 2009 +0200
@@ -129,6 +129,12 @@
    * 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);
--- a/src/mobility/hierarchical-mobility-model.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/mobility/hierarchical-mobility-model.h	Fri Sep 18 22:18:06 2009 +0200
@@ -80,6 +80,7 @@
    * 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 @@
    * 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);
   
--- a/src/node/inet-socket-address.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/node/inet-socket-address.h	Fri Sep 18 22:18:06 2009 +0200
@@ -87,6 +87,7 @@
   void SetIpv4 (Ipv4Address address);
 
   /**
+   * \param address address to test
    * \returns true if the address matches, false otherwise.
    */
   static bool IsMatchingType (const Address &address);
--- a/src/node/ipv4-address.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/node/ipv4-address.h	Fri Sep 18 22:18:06 2009 +0200
@@ -210,7 +210,7 @@
    */
   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
    */
--- a/src/node/mac48-address.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/node/mac48-address.h	Fri Sep 18 22:18:06 2009 +0200
@@ -78,6 +78,7 @@
    */
   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 @@
   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);
--- a/src/node/mac64-address.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/node/mac64-address.h	Fri Sep 18 22:18:06 2009 +0200
@@ -73,6 +73,7 @@
    */
   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);
--- a/src/node/net-device.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/node/net-device.h	Fri Sep 18 22:18:06 2009 +0200
@@ -99,6 +99,7 @@
 
   /**
    * Set the address of this interface
+   * \param address address to set
    */
   virtual void SetAddress (Address address) = 0;
 
--- a/src/node/packet-socket-address.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/node/packet-socket-address.h	Fri Sep 18 22:18:06 2009 +0200
@@ -64,6 +64,7 @@
    */
   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);
--- a/src/node/packetbb.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/node/packetbb.h	Fri Sep 18 22:18:06 2009 +0200
@@ -609,6 +609,7 @@
 
   /**
    * \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
--- a/src/node/queue.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/node/queue.h	Fri Sep 18 22:18:06 2009 +0200
@@ -56,6 +56,7 @@
   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);
--- a/src/node/socket.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/node/socket.h	Fri Sep 18 22:18:06 2009 +0200
@@ -487,8 +487,9 @@
    */
   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; 
  
--- a/src/routing/global-routing/candidate-queue.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/routing/global-routing/candidate-queue.h	Fri Sep 18 22:18:06 2009 +0200
@@ -167,6 +167,7 @@
  * 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 @@
  * 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);
 
--- a/src/routing/global-routing/global-router-interface.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/routing/global-routing/global-router-interface.h	Fri Sep 18 22:18:06 2009 +0200
@@ -401,7 +401,7 @@
 /**
  * @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 @@
  * @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 @@
 
 /**
  * @brief Set the SPF status of the advertisement
- *
+ * @param status SPF status to set
  * @see SPFStatus
  */
   void SetStatus (SPFStatus status);
--- a/src/routing/static-routing/ipv4-routing-table-entry.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/routing/static-routing/ipv4-routing-table-entry.h	Fri Sep 18 22:18:06 2009 +0200
@@ -193,6 +193,7 @@
    */
   uint32_t GetNOutputInterfaces (void) const;
   /**
+   * \param n interface index
    * \return A specified output interface.
    */
   uint32_t GetOutputInterface (uint32_t n) const;
--- a/src/simulator/nstime.h	Fri Sep 18 18:21:15 2009 +0200
+++ b/src/simulator/nstime.h	Fri Sep 18 22:18:06 2009 +0200
@@ -535,6 +535,7 @@
  * Time t = Seconds (2.0);
  * Simulator::Schedule (NanoSeconds (5.0), ...);
  * \endcode
+ * \param seconds seconds value
  */
 Time Seconds (double seconds);
 
@@ -546,6 +547,7 @@
  * Time t = MilliSeconds (2);
  * Simulator::Schedule (MilliSeconds (5), ...);
  * \endcode
+ * \param ms milliseconds value
  */
 Time MilliSeconds (uint64_t ms);
 /**
@@ -556,6 +558,7 @@
  * Time t = MicroSeconds (2);
  * Simulator::Schedule (MicroSeconds (5), ...);
  * \endcode
+ * \param us microseconds value
  */
 Time MicroSeconds (uint64_t us);
 /**
@@ -566,6 +569,7 @@
  * Time t = NanoSeconds (2);
  * Simulator::Schedule (NanoSeconds (5), ...);
  * \endcode
+ * \param ns nanoseconds value
  */
 Time NanoSeconds (uint64_t ns);
 /**
@@ -576,6 +580,7 @@
  * Time t = PicoSeconds (2);
  * Simulator::Schedule (PicoSeconds (5), ...);
  * \endcode
+ * \param ps picoseconds value
  */
 Time PicoSeconds (uint64_t ps);
 /**
@@ -586,6 +591,7 @@
  * Time t = FemtoSeconds (2);
  * Simulator::Schedule (FemtoSeconds (5), ...);
  * \endcode
+ * \param fs femtoseconds value
  */
 Time FemtoSeconds (uint64_t fs);