fix doxygen errors
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Wed, 12 Mar 2008 09:31:50 -0700
changeset 2595 b504951bcca8
parent 2594 a8f89acd17a1
child 2596 01685e2f0add
fix doxygen errors
src/applications/packet-sink/packet-sink.h
src/core/attribute.h
src/core/object.h
src/devices/wifi/propagation-loss-model.h
src/devices/wifi/wifi-channel.h
src/devices/wifi/wifi.h
src/internet-node/arp-l3-protocol.h
src/internet-node/ipv4-interface.h
src/internet-node/udp-l4-protocol.h
src/mobility/random-direction-2d-mobility-model.h
src/mobility/random-walk-2d-mobility-model.h
--- a/src/applications/packet-sink/packet-sink.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/applications/packet-sink/packet-sink.h	Wed Mar 12 09:31:50 2008 -0700
@@ -54,11 +54,6 @@
 {
 public:
   static TypeId GetTypeId (void);
-  /**
-   * \param n node associated to this application
-   * \param local local address to bind to
-   * \param tid string to identify transport protocol of interest
-   */
   PacketSink ();
 
   virtual ~PacketSink ();
--- a/src/core/attribute.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/core/attribute.h	Wed Mar 12 09:31:50 2008 -0700
@@ -185,7 +185,7 @@
    * This method expects that the caller has checked that the input value is
    * valid with AttributeChecker::Check.
    */
-  virtual bool Get (const ObjectBase * object, Attribute value) const = 0;
+  virtual bool Get (const ObjectBase * object, Attribute attribute) const = 0;
 private:
   mutable uint32_t m_count;
 };
--- a/src/core/object.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/core/object.h	Wed Mar 12 09:31:50 2008 -0700
@@ -107,7 +107,7 @@
   static uint32_t GetRegisteredN (void);
   /**
    * \param i index
-   * \returns the TypeId instance whose index is \i.
+   * \returns the TypeId instance whose index is i.
    */
   static TypeId GetRegistered (uint32_t i);
 
@@ -156,14 +156,14 @@
   /**
    * \param i index into attribute array
    * \returns the name associated to the attribute whose
-   *          index is \i i.
+   *          index is i.
    */
   std::string GetAttributeName (uint32_t i) const;
   std::string GetAttributeHelp (uint32_t i) const;
   /**
    * \param i index into attribute array
    * \returns the full name associated to the attribute whose
-   *          index is \i i.
+   *          index is i.
    */
   std::string GetAttributeFullName (uint32_t i) const;
 
@@ -225,8 +225,10 @@
   /**
    * \param name the name of the new attribute
    * \param help some help text which describes the purpose of this
-   *        attribute
-   * \param param an instance of the associated Accessor subclass
+   *        attribute.
+   * \param initialValue the initial value for this attribute.
+   * \param accessor an instance of the associated AttributeAccessor subclass.
+   * \param checker an instance of the associated AttributeChecker subclass.
    * \returns this TypeId instance
    *
    * Record in this TypeId the fact that a new attribute exists.
@@ -234,7 +236,7 @@
   TypeId AddAttribute (std::string name,
                        std::string help, 
                        Attribute initialValue,
-                       Ptr<const AttributeAccessor> spec,
+                       Ptr<const AttributeAccessor> accessor,
                        Ptr<const AttributeChecker> checker);
 
   /**
@@ -242,7 +244,9 @@
    * \param help some help text which describes the purpose of this
    *        attribute
    * \param flags flags which describe how this attribute can be read and/or written.
-   * \param param an instance of the associated Accessor subclass
+   * \param initialValue the initial value for this attribute.
+   * \param accessor an instance of the associated AttributeAccessor subclass.
+   * \param checker an instance of the associated AttributeChecker subclass.
    * \returns this TypeId instance
    *
    * Record in this TypeId the fact that a new attribute exists.
@@ -304,6 +308,8 @@
 
   /**
    * \param fullName the full name of the requested attribute
+   * \param info a pointer to the TypeId::AttributeInfo data structure
+   *        where the result value of this method will be stored.
    * \returns the Accessor associated to the requested attribute
    */
   static bool LookupAttributeByFullName (std::string fullName, struct AttributeInfo *info);
@@ -438,8 +444,7 @@
   bool GetAttribute (std::string name, std::string &value) const;
   /**
    * \param name the name of the attribute to read
-   * \param value a reference to the object where the value of the 
-   *        attribute should be stored.
+   * \returns the attribute read.
    *
    * If the input attribute name does not exist, this method crashes.
    */
--- a/src/devices/wifi/propagation-loss-model.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/devices/wifi/propagation-loss-model.h	Wed Mar 12 09:31:50 2008 -0700
@@ -56,9 +56,6 @@
 public:
   static TypeId GetTypeId (void);
 
-  /**
-   * Use the default parameters from \valueref{RandomPropagationLossDistribution}.
-   */
   RandomPropagationLossModel ();
   virtual ~RandomPropagationLossModel ();
 
@@ -100,17 +97,12 @@
  *
  * This model is invalid for small distance values.
  * The current implementation returns the txpower as the rxpower
- * for any distance smaller than \valueref{FriisPropagationLossMinDistance}.
+ * for any distance smaller than MinDistance.
  */
 class FriisPropagationLossModel : public PropagationLossModel
 {
 public:
   static TypeId GetTypeId (void);
-  /**
-   * Use the default parameters from \valueref{FriisPropagationLossLambda},
-   * \valueref{FriisPropagationLossSystemLoss}, and,
-   * \valueref{FriisPropagationLossMinDistance}.
-   */
   FriisPropagationLossModel ();
   /**
    * \param frequency (Hz)
@@ -186,12 +178,6 @@
 {
 public:
   static TypeId GetTypeId (void);
-  /**
-   * Use the default parameters from
-   * \valueref{LogDistancePropagationLossExponent}, and,
-   * \valueref{LogDistancePropagationLossReferenceType}
-   * to create a new propagation loss model.
-   */
   LogDistancePropagationLossModel ();
 
   /**
--- a/src/devices/wifi/wifi-channel.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/devices/wifi/wifi-channel.h	Wed Mar 12 09:31:50 2008 -0700
@@ -50,13 +50,6 @@
 public:
   static TypeId GetTypdId (void);
 
-  /**
-   * arg1: the packet to receive
-   * arg2: the rx power of the packet to receive (dbm)
-   * arg3: the tx mode of the packet to receive
-   * arg4: the preamble of the packet to receive
-   */
-  typedef Callback<void,Ptr<Packet>,double,WifiMode,WifiPreamble> ReceiveCallback;
   WifiChannel ();
   virtual ~WifiChannel ();
 
@@ -80,8 +73,8 @@
   /**
    * \param device the device to add to the list of connected
    *        devices.
-   * \param callback the callback to invoke when a packet must
-   *        be received.
+   * \param phy the physical layer which will receive packets
+   *        on behalf of the device.
    *
    * This method should not be invoked by normal users. It is 
    * currently invoked only from WifiPhy::SetChannel.
--- a/src/devices/wifi/wifi.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/devices/wifi/wifi.h	Wed Mar 12 09:31:50 2008 -0700
@@ -42,20 +42,13 @@
  * "Yet Another Network Simulator", available there: http://cutebugs.net/files/wns2-yans.pdf
  *
  * It also provides a set of Rate control algorithms:
- *   - ns3::ArfMacStations (initialized from \valueref{WifiArfTimerThreshold}, and,
- *     \valueref{WifiArfSuccessThreshold})
- *   - ns3::AArfMacStations (initialized from \valueref{WifiAarfMinSuccessThreshold},
- *     \valueref{WifiAarfMinTimerThreshold}, \valueref{WifiAarfSuccessK}, 
- *     \valueref{WifiAarfMaxSuccessThreshold}, and, \valueref{WifiAarfTimerK}
- *   - ns3::IdealMacStations (initialized from \valueref{WifiIdealRateControlBerThreshold})
- *   - ns3::CrMacStations (initialized from \valueref{WifiConstantDataRate}, and,
- *     \valueref{WifiConstantCtlRate}).
+ *   - ns3::ArfMacStations 
+ *   - ns3::AArfMacStations
+ *   - ns3::IdealMacStations
+ *   - ns3::CrMacStations
  *   - ns3::OnoeMacStations
  *   - ns3::AmrrMacStations
  *
- * The type of rate control algorithm is controlled through \valueref{WifiRateControlAlgorithm}.
- *
- *
  * \section Wifi Tutorial
  *
  *
--- a/src/internet-node/arp-l3-protocol.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/internet-node/arp-l3-protocol.h	Wed Mar 12 09:31:50 2008 -0700
@@ -41,10 +41,7 @@
 public:
   static TypeId GetTypeId (void);
   static const uint16_t PROT_NUMBER;
-  /**
-   * \brief Constructor
-   * \param node The node which this ARP object is associated with
-   */
+
   ArpL3Protocol ();
   virtual ~ArpL3Protocol ();
 
--- a/src/internet-node/ipv4-interface.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/internet-node/ipv4-interface.h	Wed Mar 12 09:31:50 2008 -0700
@@ -64,11 +64,6 @@
 class Ipv4Interface  : public Object
 {
 public:
-  /**
-   * \param nd the NetDevice associated to this Ipv4Interface.
-   *           This value can be zero in which case the MTU
-   *           of this interface will be 2^(16-1).
-   */
   Ipv4Interface ();
   virtual ~Ipv4Interface();
 
--- a/src/internet-node/udp-l4-protocol.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/internet-node/udp-l4-protocol.h	Wed Mar 12 09:31:50 2008 -0700
@@ -42,10 +42,7 @@
 public:
   static TypeId GetTypeId (void);
   static const uint8_t PROT_NUMBER;
-  /**
-   * \brief Constructor
-   * \param node The node this protocol is associated with
-   */
+
   UdpL4Protocol ();
   virtual ~UdpL4Protocol ();
 
--- a/src/mobility/random-direction-2d-mobility-model.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/mobility/random-direction-2d-mobility-model.h	Wed Mar 12 09:31:50 2008 -0700
@@ -46,11 +46,6 @@
  public:
   static TypeId GetTypeId (void);
 
-  /**
-   * Create from \valueref{RandomDirection2dSpeed},
-   * \valueref{RandomDirection2dPause}, and,
-   * \valueref{RandomDirection2dArea}.
-   */
   RandomDirection2dMobilityModel ();
  private:
   void Start (void);
--- a/src/mobility/random-walk-2d-mobility-model.h	Tue Mar 11 13:46:22 2008 -0700
+++ b/src/mobility/random-walk-2d-mobility-model.h	Wed Mar 12 09:31:50 2008 -0700
@@ -40,11 +40,6 @@
  * either a fixed distance has been walked or until a fixed amount
  * of time.
  *
- * The parameters of the model can be specified either with the DefaultValue::Bind
- * function and the variables \valueref{RandomWalk2dSpeed}, \valueref{RandomWalk2dMode}, 
- * \valueref{RandomWalk2dDistance}, \valueref{RandomWalk2dTime}, and, \valueref{RandomWalk2dBounds} or
- * with an instance of the RandomWalk2dMobilityModelParameters class which
- * must be fed to the RandomWalk2dMobilityModel constructors.
  */
 class RandomWalk2dMobilityModel : public MobilityModel 
 {
@@ -56,15 +51,6 @@
     MODE_TIME
   };
 
-  /**
-   * Instantiate a set of RandomWalk parameters initialized
-   * with construction values from \valueref{RandomWalk2dMode},
-   * \valueref{RandomWalk2dDistance}, \valueref{RandomWalk2dTime},
-   * \valueref{RandomWalk2dSpeed}, \valueref{RandomWalk2dDirection},
-   * and, \valueref{RandomWalk2dBounds}.
-   *
-   * The default position is (0,0,0)
-   */
   RandomWalk2dMobilityModel ();
 
  private: