diff --git a/src/core/names.cc b/src/core/names.cc index b7d6f4464..5d6aa45a5 100644 --- a/src/core/names.cc +++ b/src/core/names.cc @@ -83,7 +83,7 @@ public: NamesPriv (); ~NamesPriv (); - bool Add (std::string name, Ptr obj); + bool Add (std::string name, Ptr object); bool Add (std::string path, std::string name, Ptr object); bool Add (Ptr context, std::string name, Ptr object); diff --git a/src/core/names.h b/src/core/names.h index cbb61bef2..00808817b 100644 --- a/src/core/names.h +++ b/src/core/names.h @@ -45,7 +45,7 @@ public: * ("/Names") in the path. * * As well as specifying a name at the root of the "/Names" namespace, the - * the parameter can contain a path that fully qualifies the name to + * name parameter can contain a path that fully qualifies the name to * be added. For example, if you previously have named an object "client" * in the root namespace as above, you could name an object "under" that * name by making a call like Names::Add ("/Names/client/eth0", obj). This @@ -63,9 +63,9 @@ public: * * \param name The name of the object you want to associate; which may be * prepended with a path to that object. - * \param obj A smart pointer to the object itself. + * \param object A smart pointer to the object itself. */ - static void Add (std::string name, Ptr obj); + static void Add (std::string name, Ptr object); /** * \brief An intermediate form of Names::Add allowing you to provide a path to @@ -94,7 +94,7 @@ public: * \param path A path name describing a previously named object under which * you want this new name to be defined. * \param name The name of the object you want to associate. - * \param obj A smart pointer to the object itself. + * \param object A smart pointer to the object itself. * * \see Names::Add (Ptr context, std::string name, Ptr object); */ @@ -145,7 +145,7 @@ public: * \param context A smart pointer to an object that is used in place of the path * under which you want this new name to be defined. * \param name The name of the object you want to associate. - * \param obj A smart pointer to the object itself. + * \param object A smart pointer to the object itself. */ static void Add (Ptr context, std::string name, Ptr object); @@ -162,7 +162,7 @@ public: * level ("/Names") in the path. * * As well as specifying a name at the root of the "/Names" namespace, the - * the parameter can contain a path that fully qualifies the name to + * name parameter can contain a path that fully qualifies the name to * be changed. For example, if you previously have (re)named an object * "server" in the root namespace as above, you could then rename an object * "under" that name by making a call like Names::Rename ("/Names/server/csma", "eth0"). diff --git a/src/devices/wifi/propagation-loss-model.h b/src/devices/wifi/propagation-loss-model.h index 35d6a5cf8..365bbd702 100644 --- a/src/devices/wifi/propagation-loss-model.h +++ b/src/devices/wifi/propagation-loss-model.h @@ -355,7 +355,7 @@ public: FixedRssLossModel (); virtual ~FixedRssLossModel (); /** - * \param RSS (dBm) the received signal strength + * \param rss (dBm) the received signal strength * * Set the RSS. */ diff --git a/src/devices/wifi/wifi.h b/src/devices/wifi/wifi.h index 892240aaf..695e3d41e 100644 --- a/src/devices/wifi/wifi.h +++ b/src/devices/wifi/wifi.h @@ -7,7 +7,7 @@ * The set of 802.11 models provided in ns-3 attempts to provide * an accurate MAC-level implementation of the 802.11 specification * and to provide a not-so-slow PHY-level model of the 802.11a - * specification. + * and 802.11b specifications. * * The current implementation provides roughly 4 levels of models: * - the PHY layer models @@ -52,7 +52,7 @@ * Access class * * - * 7 + * 7 * AC_VO * * @@ -96,9 +96,9 @@ * * The PHY layer implements a single model in the ns3::WifiPhy class: the * physical layer model implemented there is described fully in a paper titled - * "Yet Another Network Simulator", available there: http://cutebugs.net/files/wns2-yans.pdf - * - * It also provides a set of Rate control algorithms: + * "Yet Another Network Simulator", available at: http://cutebugs.net/files/wns2-yans.pdf and recently extended to cover 802.11b physical layer. + * + * The Wifi Model also provides a set of Rate control algorithms: * - ns3::ArfMacStations * - ns3::AArfMacStations * - ns3::IdealMacStations diff --git a/src/helper/mobility-helper.h b/src/helper/mobility-helper.h index 99d4e9b61..cbce7d8fa 100644 --- a/src/helper/mobility-helper.h +++ b/src/helper/mobility-helper.h @@ -125,7 +125,7 @@ public: * The input item should be a node instance to which a mobility model * has already been aggregated (usually by a call to Install). * - * If this this stack is not empty when MobilityHelper::Install + * If this stack is not empty when MobilityHelper::Install * is called, the model from the top of the stack is used * to create a ns3::HierarchicalMobilityModel to make the * newly-created models define their positions relative to that @@ -138,13 +138,13 @@ public: */ void PushReferenceMobilityModel (Ptr reference); /** - * \param reference item to push. + * \param referenceName named item to push. * * Push an item on the top of the stack of "reference mobility models". * The input item should be a node instance to which a mobility model * has already been aggregated (usually by a call to Install). * - * If this this stack is not empty when MobilityHelper::Install + * If this stack is not empty when MobilityHelper::Install * is called, the model from the top of the stack is used * to create a ns3::HierarchicalMobilityModel to make the * newly-created models define their positions relative to that diff --git a/src/helper/on-off-helper.h b/src/helper/on-off-helper.h index 497666777..087c30777 100644 --- a/src/helper/on-off-helper.h +++ b/src/helper/on-off-helper.h @@ -76,7 +76,7 @@ public: * Install an ns3::OnOffApplication on the node configured with all the * attributes set with SetAttribute. * - * \param node The node on which an OnOffApplication will be installed. + * \param nodeName The node on which an OnOffApplication will be installed. * \returns Container of Ptr to the applications installed. */ ApplicationContainer Install (std::string nodeName) const; diff --git a/src/helper/point-to-point-helper.h b/src/helper/point-to-point-helper.h index 483a32a0a..b55734e10 100644 --- a/src/helper/point-to-point-helper.h +++ b/src/helper/point-to-point-helper.h @@ -218,8 +218,8 @@ public: NetDeviceContainer Install (std::string aName, Ptr b); /** - * \param aName Name of first node - * \param bName Name of second node + * \param aNode Name of first node + * \param bNode Name of second node * * Saves you from having to construct a temporary NodeContainer. */ diff --git a/src/internet-stack/ipv4-interface.h b/src/internet-stack/ipv4-interface.h index 3e5c5334f..a3210395d 100644 --- a/src/internet-stack/ipv4-interface.h +++ b/src/internet-stack/ipv4-interface.h @@ -130,7 +130,7 @@ public: uint32_t AddAddress (Ipv4InterfaceAddress address); /** - * \param i Index of Ipv4InterfaceAddress to return + * \param index Index of Ipv4InterfaceAddress to return * \returns The Ipv4InterfaceAddress address whose index is i */ Ipv4InterfaceAddress GetAddress (uint32_t index) const; @@ -141,7 +141,7 @@ public: uint32_t GetNAddresses (void) const; /** - * \param i index of Ipv4InterfaceAddress to remove from address list. + * \param index index of Ipv4InterfaceAddress to remove from address list. */ void RemoveAddress (uint32_t index); diff --git a/src/internet-stack/ipv4-l3-protocol.cc b/src/internet-stack/ipv4-l3-protocol.cc index 3caa7d2a6..1a9272fcf 100644 --- a/src/internet-stack/ipv4-l3-protocol.cc +++ b/src/internet-stack/ipv4-l3-protocol.cc @@ -164,10 +164,10 @@ Ipv4L3Protocol::NotifyNewAggregate () } void -Ipv4L3Protocol::SetRoutingProtocol (Ptr routing) +Ipv4L3Protocol::SetRoutingProtocol (Ptr routingProtocol) { NS_LOG_FUNCTION (this); - m_routingProtocol = routing; + m_routingProtocol = routingProtocol; // XXX should check all interfaces to see if any were set to Up state // prior to a routing protocol being added if (GetStaticRouting () != 0) diff --git a/src/internet-stack/ipv4-l3-protocol.h b/src/internet-stack/ipv4-l3-protocol.h index a0d750224..9b371a209 100644 --- a/src/internet-stack/ipv4-l3-protocol.h +++ b/src/internet-stack/ipv4-l3-protocol.h @@ -67,7 +67,8 @@ public: void SetNode (Ptr node); // functions defined in base class Ipv4 - void SetRoutingProtocol (Ptr routing); + + void SetRoutingProtocol (Ptr routingProtocol); Ptr GetRoutingProtocol (void) const; Ptr CreateRawSocket (void); diff --git a/src/node/ipv4.h b/src/node/ipv4.h index 771c33130..d5f13dcd7 100644 --- a/src/node/ipv4.h +++ b/src/node/ipv4.h @@ -84,7 +84,7 @@ public: * registered. If you want to add multiple routing protocols, you must * add them to a Ipv4ListRoutingProtocol directly. * - * \param routing smart pointer to Ipv4RoutingProtocol object + * \param routingProtocol smart pointer to Ipv4RoutingProtocol object */ virtual void SetRoutingProtocol (Ptr routingProtocol) = 0; @@ -132,7 +132,8 @@ public: * has an Ipv4 address within the prefix specified by the input * address and mask parameters * - * \param addr The IP address assigned to the interface of interest. + * \param address The IP address assigned to the interface of interest. + * \param mask The IP prefix to use in the mask * \returns The interface number of the Ipv4 interface with the given * address or -1 if not found. * @@ -206,7 +207,7 @@ public: virtual bool IsUp (uint32_t interface) const = 0; /** - * \param i interface Interface number of Ipv4 interface + * \param interface Interface number of Ipv4 interface * * Set the interface into the "up" state. In this state, it is * considered valid during Ipv4 forwarding. diff --git a/src/routing/olsr/olsr-repositories.h b/src/routing/olsr/olsr-repositories.h index 4990a4094..b0c081c05 100644 --- a/src/routing/olsr/olsr-repositories.h +++ b/src/routing/olsr/olsr-repositories.h @@ -21,7 +21,7 @@ */ /// -/// \file OLSR_olsr-repositories.h +/// \file olsr-repositories.h /// \brief Here are defined all data structures needed by an OLSR node. ///