Fix easy doxygen warnings
authorPeter D. Barnes, Jr. <barnes26@llnl.gov>
Wed, 20 Jun 2012 06:50:50 -0700
changeset 8866 a44fcd5f9c1d
parent 8865 a55aa66b5132
child 8867 743aeb2fef78
Fix easy doxygen warnings
src/antenna/model/antenna-model.h
src/csma/helper/csma-helper.h
src/emu/helper/emu-helper.h
src/energy/helper/wifi-radio-energy-model-helper.h
src/energy/model/wifi-radio-energy-model.h
src/energy/test/rv-battery-model-test.cc
src/internet/helper/internet-stack-helper.h
src/internet/model/global-route-manager-impl.h
src/mobility/test/ns2-mobility-helper-test-suite.cc
src/netanim/helper/animation-interface-helper.h
src/point-to-point/helper/point-to-point-helper.h
src/spectrum/model/spectrum-value.cc
src/spectrum/model/spectrum-value.h
src/uan/helper/acoustic-modem-energy-model-helper.h
src/uan/model/acoustic-modem-energy-model.h
src/wifi/helper/yans-wifi-helper.h
src/wifi/test/dcf-manager-test.cc
src/wifi/test/tx-duration-test.cc
--- a/src/antenna/model/antenna-model.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/antenna/model/antenna-model.h	Wed Jun 20 06:50:50 2012 -0700
@@ -56,7 +56,7 @@
   /**
    * this method is expected to be re-implemented by each antenna model 
    * 
-   * \param the spherical angles at which the radiation pattern should
+   * \param a the spherical angles at which the radiation pattern should
    * be evaluated
    * 
    * \return the power gain in dBi of the antenna radiation pattern at
--- a/src/csma/helper/csma-helper.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/csma/helper/csma-helper.h	Wed Jun 20 06:50:50 2012 -0700
@@ -222,6 +222,7 @@
    * \param stream The output stream object to use when logging ascii traces.
    * \param prefix Filename prefix to use for ascii trace files.
    * \param nd Net device for which you want to enable tracing.
+   * \param explicitFilename Treat the prefix as an explicit filename if true
    */
   virtual void EnableAsciiInternal (Ptr<OutputStreamWrapper> stream, 
                                     std::string prefix, 
--- a/src/emu/helper/emu-helper.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/emu/helper/emu-helper.h	Wed Jun 20 06:50:50 2012 -0700
@@ -138,6 +138,7 @@
    * \param stream The output stream object to use when logging ascii traces.
    * \param prefix Filename prefix to use for ascii trace files.
    * \param nd Net device for which you want to enable tracing.
+   * \param explicitFilename Treat the prefix as an explicit filename if true
    */
   virtual void EnableAsciiInternal (Ptr<OutputStreamWrapper> stream, 
                                     std::string prefix, 
--- a/src/energy/helper/wifi-radio-energy-model-helper.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/energy/helper/wifi-radio-energy-model-helper.h	Wed Jun 20 06:50:50 2012 -0700
@@ -66,6 +66,7 @@
 private:
   /**
    * \param device Pointer to the NetDevice to install DeviceEnergyModel.
+   * \param source Pointer to EnergySource to install.
    *
    * Implements DeviceEnergyModel::Install.
    */
--- a/src/energy/model/wifi-radio-energy-model.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/energy/model/wifi-radio-energy-model.h	Wed Jun 20 06:50:50 2012 -0700
@@ -229,7 +229,7 @@
   virtual double DoGetCurrentA (void) const;
 
   /**
-   * \param currentState New state the radio device is currently in.
+   * \param state New state the radio device is currently in.
    *
    * Sets current state. This function is private so that only the energy model
    * can change its own state.
--- a/src/energy/test/rv-battery-model-test.cc	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/energy/test/rv-battery-model-test.cc	Wed Jun 20 06:50:50 2012 -0700
@@ -76,7 +76,7 @@
   /**
    * \param loads Load profile.
    * \param timeStamps Time stamps.
-   * \param expLifeTime Expected lifetime.
+   * \param expLifetime Expected lifetime.
    * \returns False if no error occurs.
    *
    * Runs simulation with variable load and checks the battery lifetime with
--- a/src/internet/helper/internet-stack-helper.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/internet/helper/internet-stack-helper.h	Wed Jun 20 06:50:50 2012 -0700
@@ -186,6 +186,7 @@
    * @param prefix Filename prefix to use for pcap files.
    * @param ipv4 Ptr to the Ipv4 interface on which you want to enable tracing.
    * @param interface Interface ID on the Ipv4 on which you want to enable tracing.
+   * @param explicitFilename Treat the prefix as an explicit filename if true
    */
   virtual void EnablePcapIpv4Internal (std::string prefix, 
                                        Ptr<Ipv4> ipv4, 
@@ -201,6 +202,7 @@
    * @param prefix Filename prefix to use for ascii trace files.
    * @param ipv4 Ptr to the Ipv4 interface on which you want to enable tracing.
    * @param interface Interface ID on the Ipv4 on which you want to enable tracing.
+   * @param explicitFilename Treat the prefix as an explicit filename if true
    */
   virtual void EnableAsciiIpv4Internal (Ptr<OutputStreamWrapper> stream, 
                                         std::string prefix, 
@@ -215,6 +217,7 @@
    * @param prefix Filename prefix to use for pcap files.
    * @param ipv6 Ptr to the Ipv6 interface on which you want to enable tracing.
    * @param interface Interface ID on the Ipv6 on which you want to enable tracing.
+   * @param explicitFilename Treat the prefix as an explicit filename if true
    */
   virtual void EnablePcapIpv6Internal (std::string prefix, 
                                        Ptr<Ipv6> ipv6, 
@@ -230,6 +233,7 @@
    * @param prefix Filename prefix to use for ascii trace files.
    * @param ipv6 Ptr to the Ipv6 interface on which you want to enable tracing.
    * @param interface Interface ID on the Ipv6 on which you want to enable tracing.
+   * @param explicitFilename Treat the prefix as an explicit filename if true
    */
   virtual void EnableAsciiIpv6Internal (Ptr<OutputStreamWrapper> stream, 
                                         std::string prefix, 
--- a/src/internet/model/global-route-manager-impl.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/internet/model/global-route-manager-impl.h	Wed Jun 20 06:50:50 2012 -0700
@@ -336,8 +336,6 @@
  * @see GlobalRouter
  * @see GlobalRoutingLSA
  * @see GlobalRoutingLinkRecord
- * @param nextHop The IP address to use when forwarding packets to the host
- * or network represented by "this" SPFVertex.
  * @param exit The pair of next-hop-IP and outgoing-interface-index to use when 
  * forwarding packets to the host or network represented by "this" SPFVertex.
  */
--- a/src/mobility/test/ns2-mobility-helper-test-suite.cc	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/mobility/test/ns2-mobility-helper-test-suite.cc	Wed Jun 20 06:50:50 2012 -0700
@@ -93,6 +93,7 @@
    * Create new test case. To make it useful SetTrace () and AddReferencePoint () must be called
    *
    * \param name        Short description
+   * \param timeLimit   Test time limit
    * \param nodes       Number of nodes used in the test trace, 1 by default
    */
   Ns2MobilityHelperTest (std::string const & name, Time timeLimit, uint32_t nodes = 1)
--- a/src/netanim/helper/animation-interface-helper.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/netanim/helper/animation-interface-helper.h	Wed Jun 20 06:50:50 2012 -0700
@@ -142,6 +142,7 @@
    * \param fbTx First bit transmit time
    * \param lbTx Last bit transmit time
    * \param txLoc Transmitter Location
+   * \param txNodeId Tx Node Id if NetDevice is unknown
    *
    */
   AnimPacketInfo(Ptr <const NetDevice> tx_nd, const Time& fbTx, const Time& lbTx,Vector txLoc, uint32_t txNodeId = 0);
--- a/src/point-to-point/helper/point-to-point-helper.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/point-to-point/helper/point-to-point-helper.h	Wed Jun 20 06:50:50 2012 -0700
@@ -170,6 +170,7 @@
    * \param stream The output stream object to use when logging ascii traces.
    * \param prefix Filename prefix to use for ascii trace files.
    * \param nd Net device for which you want to enable tracing.
+   * \param explicitFilename Treat the prefix as an explicit filename if true
    */
   virtual void EnableAsciiInternal (
     Ptr<OutputStreamWrapper> stream,
--- a/src/spectrum/model/spectrum-value.cc	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/spectrum/model/spectrum-value.cc	Wed Jun 20 06:50:50 2012 -0700
@@ -388,19 +388,19 @@
 }
 
 double
-Integral (const SpectrumValue& x)
+Integral (const SpectrumValue& arg)
 {
   double i = 0;
-  Values::const_iterator vit = x.ConstValuesBegin ();
-  Bands::const_iterator bit = x.ConstBandsBegin ();
-  while (vit != x.ConstValuesEnd ())
+  Values::const_iterator vit = arg.ConstValuesBegin ();
+  Bands::const_iterator bit = arg.ConstBandsBegin ();
+  while (vit != arg.ConstValuesEnd ())
     {
-      NS_ASSERT (bit != x.ConstBandsEnd ());
+      NS_ASSERT (bit != arg.ConstBandsEnd ());
       i += (*vit) * (bit->fh - bit->fl);
       ++vit;
       ++bit;
     }
-  NS_ASSERT (bit == x.ConstBandsEnd ());
+  NS_ASSERT (bit == arg.ConstBandsEnd ());
   return i;
 }
 
--- a/src/spectrum/model/spectrum-value.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/spectrum/model/spectrum-value.h	Wed Jun 20 06:50:50 2012 -0700
@@ -540,7 +540,7 @@
 SpectrumValue Log10 (const SpectrumValue& arg);
 SpectrumValue Log2 (const SpectrumValue& arg);
 SpectrumValue Log (const SpectrumValue& arg);
-double Integral (const SpectrumValue& x);
+double Integral (const SpectrumValue& arg);
 
 
 } // namespace ns3
--- a/src/uan/helper/acoustic-modem-energy-model-helper.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/uan/helper/acoustic-modem-energy-model-helper.h	Wed Jun 20 06:50:50 2012 -0700
@@ -64,6 +64,7 @@
 private:
   /**
    * \param device Pointer to the NetDevice to install DeviceEnergyModel.
+   * \param source Pointer to EnergySource installed on node.
    *
    * Implements DeviceEnergyModel::Install.
    */
--- a/src/uan/model/acoustic-modem-energy-model.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/uan/model/acoustic-modem-energy-model.h	Wed Jun 20 06:50:50 2012 -0700
@@ -196,7 +196,7 @@
   bool IsStateTransitionValid (const int destState);
 
   /**
-   * \param currentState New state the modem is currently in.
+   * \param state New state the modem is currently in.
    *
    * Sets current state. This function is private so that only the energy model
    * can change its own state.
--- a/src/wifi/helper/yans-wifi-helper.h	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/wifi/helper/yans-wifi-helper.h	Wed Jun 20 06:50:50 2012 -0700
@@ -266,6 +266,7 @@
    * \param stream The output stream object to use when logging ascii traces.
    * \param prefix Filename prefix to use for ascii trace files.
    * \param nd Net device for which you want to enable tracing.
+   * \param explicitFilename Treat the prefix as an explicit filename if true
    */
   virtual void EnableAsciiInternal (Ptr<OutputStreamWrapper> stream,
                                     std::string prefix,
--- a/src/wifi/test/dcf-manager-test.cc	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/wifi/test/dcf-manager-test.cc	Wed Jun 20 06:50:50 2012 -0700
@@ -85,7 +85,11 @@
                          uint64_t expectedGrantTime, uint32_t from);
   void AddAccessRequestWithAckTimeout (uint64_t at, uint64_t txTime,
                                        uint64_t expectedGrantTime, uint32_t from);
+  ///\param at time to schedule DoAccessRequest event
+  ///\param txTime DoAccessRequest txTime
+  ///\param expectedGrantTime DoAccessRequest expectedGrantTime
   ///\param ackDelay is delay of the ack after txEnd
+  ///\param from DoAccessRequest DcfStateTest
   void AddAccessRequestWithSuccessfullAck (uint64_t at, uint64_t txTime,
                                            uint64_t expectedGrantTime, uint32_t ackDelay, uint32_t from);
   void DoAccessRequest (uint64_t txTime, uint64_t expectedGrantTime, DcfStateTest *state);
--- a/src/wifi/test/tx-duration-test.cc	Mon Jun 18 06:35:32 2012 -0700
+++ b/src/wifi/test/tx-duration-test.cc	Wed Jun 20 06:50:50 2012 -0700
@@ -43,7 +43,7 @@
    *
    * @param size size of payload in octets (includes everything after the PLCP header)
    * @param payloadMode the WifiMode used
-   * @param knownPlcpLengthFieldValue the known value of the Length field in the PLCP header
+   * @param knownDurationMicroSeconds the known payload size
    *
    * @return true if values correspond, false otherwise
    */
@@ -56,7 +56,7 @@
    * @param size size of payload in octets (includes everything after the PLCP header)
    * @param payloadMode the WifiMode used
    * @param preamble the WifiPreamble used
-   * @param knownPlcpLengthFieldValue the known value of the Length field in the PLCP header
+   * @param knownDurationMicroSeconds the known value of the transmission
    *
    * @return true if values correspond, false otherwise
    */