diff --git a/src/applications/packet-sink/packet-sink.h b/src/applications/packet-sink/packet-sink.h index e1d412b57..70f190ab0 100644 --- a/src/applications/packet-sink/packet-sink.h +++ b/src/applications/packet-sink/packet-sink.h @@ -54,11 +54,6 @@ class PacketSink : public Application { 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 (); diff --git a/src/core/attribute.h b/src/core/attribute.h index 3082cf15d..dee008bef 100644 --- a/src/core/attribute.h +++ b/src/core/attribute.h @@ -185,7 +185,7 @@ public: * 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; }; diff --git a/src/core/object.h b/src/core/object.h index 2a1c87214..3da94556a 100644 --- a/src/core/object.h +++ b/src/core/object.h @@ -107,7 +107,7 @@ public: 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 @@ public: /** * \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 @@ public: /** * \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 @@ public: TypeId AddAttribute (std::string name, std::string help, Attribute initialValue, - Ptr spec, + Ptr accessor, Ptr checker); /** @@ -242,7 +244,9 @@ public: * \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 @@ private: /** * \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 @@ public: 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. */ diff --git a/src/devices/wifi/propagation-loss-model.h b/src/devices/wifi/propagation-loss-model.h index 08820621d..be2740e2d 100644 --- a/src/devices/wifi/propagation-loss-model.h +++ b/src/devices/wifi/propagation-loss-model.h @@ -56,9 +56,6 @@ class RandomPropagationLossModel : public PropagationLossModel public: static TypeId GetTypeId (void); - /** - * Use the default parameters from \valueref{RandomPropagationLossDistribution}. - */ RandomPropagationLossModel (); virtual ~RandomPropagationLossModel (); @@ -100,17 +97,12 @@ private: * * 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 @@ class LogDistancePropagationLossModel : public PropagationLossModel { public: static TypeId GetTypeId (void); - /** - * Use the default parameters from - * \valueref{LogDistancePropagationLossExponent}, and, - * \valueref{LogDistancePropagationLossReferenceType} - * to create a new propagation loss model. - */ LogDistancePropagationLossModel (); /** diff --git a/src/devices/wifi/wifi-channel.h b/src/devices/wifi/wifi-channel.h index 891608a78..3f0adc6ee 100644 --- a/src/devices/wifi/wifi-channel.h +++ b/src/devices/wifi/wifi-channel.h @@ -50,13 +50,6 @@ class WifiChannel : public Channel 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,double,WifiMode,WifiPreamble> ReceiveCallback; WifiChannel (); virtual ~WifiChannel (); @@ -80,8 +73,8 @@ public: /** * \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. diff --git a/src/devices/wifi/wifi.h b/src/devices/wifi/wifi.h index 1afb81d55..1610dca90 100644 --- a/src/devices/wifi/wifi.h +++ b/src/devices/wifi/wifi.h @@ -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 * * diff --git a/src/internet-node/arp-l3-protocol.h b/src/internet-node/arp-l3-protocol.h index 85ad98de0..8b7d91847 100644 --- a/src/internet-node/arp-l3-protocol.h +++ b/src/internet-node/arp-l3-protocol.h @@ -41,10 +41,7 @@ class ArpL3Protocol : public Object 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 (); diff --git a/src/internet-node/ipv4-interface.h b/src/internet-node/ipv4-interface.h index 6cfc7b749..d02afb23b 100644 --- a/src/internet-node/ipv4-interface.h +++ b/src/internet-node/ipv4-interface.h @@ -64,11 +64,6 @@ class TraceContext; 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(); diff --git a/src/internet-node/udp-l4-protocol.h b/src/internet-node/udp-l4-protocol.h index 19984804b..317ea12e0 100644 --- a/src/internet-node/udp-l4-protocol.h +++ b/src/internet-node/udp-l4-protocol.h @@ -42,10 +42,7 @@ class UdpL4Protocol : public Ipv4L4Protocol { 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 (); diff --git a/src/mobility/random-direction-2d-mobility-model.h b/src/mobility/random-direction-2d-mobility-model.h index 83eca421a..161e842c2 100644 --- a/src/mobility/random-direction-2d-mobility-model.h +++ b/src/mobility/random-direction-2d-mobility-model.h @@ -46,11 +46,6 @@ class RandomDirection2dMobilityModel : public MobilityModel public: static TypeId GetTypeId (void); - /** - * Create from \valueref{RandomDirection2dSpeed}, - * \valueref{RandomDirection2dPause}, and, - * \valueref{RandomDirection2dArea}. - */ RandomDirection2dMobilityModel (); private: void Start (void); diff --git a/src/mobility/random-walk-2d-mobility-model.h b/src/mobility/random-walk-2d-mobility-model.h index c46f1b3d6..c28f13ccd 100644 --- a/src/mobility/random-walk-2d-mobility-model.h +++ b/src/mobility/random-walk-2d-mobility-model.h @@ -40,11 +40,6 @@ namespace ns3 { * 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 @@ class RandomWalk2dMobilityModel : public MobilityModel 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: