F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen cleanup

Browse Source
This commit is contained in:
Tom Henderson
2009-05-30 15:20:56 -07:00
parent c689bb0303
commit 81bde7afdf
12 changed files with 30 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/core/names.cc
View File

@@ -83,7 +83,7 @@ public:
NamesPriv ();
~NamesPriv ();
bool Add (std::string name, Ptr<Object> obj);
bool Add (std::string name, Ptr<Object> object);
bool Add (std::string path, std::string name, Ptr<Object> object);
bool Add (Ptr<Object> context, std::string name, Ptr<Object> object);

12
src/core/names.h
View File

@@ -45,7 +45,7 @@ public:
* ("/Names") in the path.
*
* As well as specifying a name at the root of the "/Names" namespace, the
* the <name> 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<Object> obj);
static void Add (std::string name, Ptr<Object> 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<Object> context, std::string name, Ptr<Object> 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<Object> context, std::string name, Ptr<Object> 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 <name> 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").

2
src/devices/wifi/propagation-loss-model.h
View File

@@ -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.
*/

10
src/devices/wifi/wifi.h
View File

@@ -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 @@
* <td><b> Access class </b></td>
* </tr>
* <tr>
* <td> 7 </b></td>
* <td> 7 </td>
* <td> AC_VO </td>
* </tr>
* <tr>
@@ -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

6
src/helper/mobility-helper.h
View File

@@ -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<Object> 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

2
src/helper/on-off-helper.h
View File

@@ -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;

4
src/helper/point-to-point-helper.h
View File

@@ -218,8 +218,8 @@ public:
NetDeviceContainer Install (std::string aName, Ptr<Node> 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.
*/

4
src/internet-stack/ipv4-interface.h
View File

@@ -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);

4
src/internet-stack/ipv4-l3-protocol.cc
View File

@@ -164,10 +164,10 @@ Ipv4L3Protocol::NotifyNewAggregate ()
}
void
Ipv4L3Protocol::SetRoutingProtocol (Ptr<Ipv4RoutingProtocol> routing)
Ipv4L3Protocol::SetRoutingProtocol (Ptr<Ipv4RoutingProtocol> 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)

3
src/internet-stack/ipv4-l3-protocol.h
View File

@@ -67,7 +67,8 @@ public:
void SetNode (Ptr<Node> node);
// functions defined in base class Ipv4
void SetRoutingProtocol (Ptr<Ipv4RoutingProtocol> routing);
void SetRoutingProtocol (Ptr<Ipv4RoutingProtocol> routingProtocol);
Ptr<Ipv4RoutingProtocol> GetRoutingProtocol (void) const;
Ptr<Socket> CreateRawSocket (void);

7
src/node/ipv4.h
View File

@@ -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<Ipv4RoutingProtocol> 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.

2
src/routing/olsr/olsr-repositories.h
View File

@@ -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.
///