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

get rid of doxygen warnings

Browse Source
This commit is contained in:
Mathieu Lacage
2007-10-26 22:06:46 +02:00
parent 8975be38ae
commit 2f4ed00c93
8 changed files with 37 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/doxygen.conf
View File

@@ -1002,7 +1002,7 @@ INCLUDE_FILE_PATTERNS =
# undefined via #undef or recursively expanded use the := operator
# instead of the = operator.
PREDEFINED = RUN_SELF_TESTS NS3_DEBUG_ENABLE NS3_ASSERT_ENABLE
PREDEFINED = RUN_SELF_TESTS NS3_DEBUG_ENABLE NS3_ASSERT_ENABLE NS3_LOG_ENABLE
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
# this tag can be used to specify a list of macro names that should be expanded.

20
src/core/log.h
View File

@@ -88,6 +88,19 @@
#ifdef NS3_LOG_ENABLE
/**
* \param level the log level
* \param msg the message to log
*
* This macro allows you to log an arbitrary message at a specific
* log level. The log message is expected to be a C++ ostream
* message such as "my string" << aNumber << "my oth stream".
*
* Typical usage looks like:
* \code
* NS_LOG (LOG_DEBUG, "a number="<<aNumber<<", anotherNumber="<<anotherNumber);
* \endcode
*/
#define NS_LOG(level, msg) \
do \
{ \
@@ -197,7 +210,6 @@ enum LogLevel {
/**
* \param name a log component name
* \param level a logging level
* \param decorate whether or not to add function names to all logs
* \ingroup logging
*
* Enable the logging output associated with that log component.
@@ -208,7 +220,6 @@ enum LogLevel {
/**
* \param level a logging level
* \param decorate whether or not to add function names to all logs
* \ingroup logging
*
* Enable the logging output for all registered log components.
@@ -232,13 +243,10 @@ enum LogLevel {
void LogComponentDisable (char const *name, enum LogLevel level);
/**
* \param name a log component name
* \param level a logging level
* \ingroup logging
*
* Disable the logging output associated with that log component.
* The logging output can be later re-enabled with a call
* to ns3::LogComponentEnable.
* Disable all logging for all components.
*/
void LogComponentDisableAll (enum LogLevel level);

6
src/devices/csma/csma-ipv4-topology.h
View File

@@ -49,8 +49,8 @@ class CsmaIpv4Topology {
public:
/**
* \param n1 Node to be attached to the Csma channel
* \param ch CsmaChannel to which node n1 should be attached
* \param node Node to be attached to the Csma channel
* \param channel CsmaChannel to which node n1 should be attached
* \param addr Mac address of the node
*
* Add a Csma node to a Csma channel. This function adds
@@ -102,7 +102,7 @@ public:
* \param netDeviceNumber The NetDevice index number with which to associate
* the address.
* \param address The Ipv4 Address for the interface.
* \param network The network mask for the interface
* \param mask The network mask for the interface
* \param metric (optional) metric (cost) to assign for routing calculations
*
* Add an Ipv4Address to the Ipv4 interface associated with the

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

@@ -97,9 +97,9 @@ public:
*/
Ipv4Mask GetNetworkMask (void) const;
/**
* \param configured routing metric (cost) of this interface
* \param metric configured routing metric (cost) of this interface
*/
void SetMetric (uint16_t);
void SetMetric (uint16_t metric);
/**
* \returns configured routing metric (cost) of this interface
*/

14
src/internet-node/ipv4-static-routing.h
View File

@@ -209,7 +209,7 @@ public:
* @brief Add a network route to the static routing table.
*
* @param network The Ipv4Address network for this route.
* @param networkmask The Ipv4Mask to extract the network.
* @param networkMask The Ipv4Mask to extract the network.
* @param nextHop The next hop in the route to the destination network.
* @param interface The network interface index used to send packets to the
* destination.
@@ -225,7 +225,7 @@ public:
* @brief Add a network route to the static routing table.
*
* @param network The Ipv4Address network for this route.
* @param networkmask The Ipv4Mask to extract the network.
* @param networkMask The Ipv4Mask to extract the network.
* @param interface The network interface index used to send packets to the
* destination.
*
@@ -352,7 +352,7 @@ public:
* @param inputInterface The input network interface index over which to
* expect packets destined for this route. May be
* Ipv4RoutingProtocol::IF_INDEX_ANY for packets of local origin.
* @param outputInterface A vector of network interface indices used to specify
* @param outputInterfaces A vector of network interface indices used to specify
* how to send packets to the destination(s).
*
* @see Ipv4Address
@@ -411,7 +411,7 @@ public:
*
* @param i The index (into the routing table) of the multicast route to
* retrieve. If the default route has been set, it will occupy index zero.
* @return If route <i> is set, a pointer to that Ipv4MulticastRoute is
* @return If route \e i is set, a pointer to that Ipv4MulticastRoute is
* returned, otherwise a zero pointer is returned.
*
* @see Ipv4MulticastRoute
@@ -449,11 +449,11 @@ public:
*
* @param origin The IP address specified as the origin of packets for the
* route.
* @param origin The IP address specified as the multicast group addres of
* @param group The IP address specified as the multicast group addres of
* the route.
* @param inputInterfade The network interface index specified as the expected
* @param inputInterface The network interface index specified as the expected
* input interface for the route.
* @returns True if a route was found and removed, false otherwise.
* @returns true if a route was found and removed, false otherwise.
*
* @see Ipv4MulticastRoute
* @see Ipv4StaticRouting::AddMulticastRoute

3
src/internet-node/udp-l4-protocol.h
View File

@@ -77,10 +77,11 @@ public:
Ipv4Address saddr, Ipv4Address daddr,
uint16_t sport, uint16_t dport);
/**
* \brief Recieve a packet up the protocol stack
* \brief Receive a packet up the protocol stack
* \param p The Packet to dump the contents into
* \param source The source's Ipv4Address
* \param destination The destinations Ipv4Address
* \param interface the interface from which the packet is coming.
*/
// inherited from Ipv4L4Protocol
virtual void Receive(Packet& p,

6
src/node/ipv4.h
View File

@@ -411,13 +411,13 @@ public:
virtual Ipv4Address GetSourceAddress (Ipv4Address destination) const = 0;
/**
* \param destination The IP address of a hypothetical destination.
* \param dest The IP address of a hypothetical destination.
* \param ifIndex filled in with the interface index that will be used to
* send a packet to the hypothetical destination.
* \returns True if a single interface can be identified, false otherwise.
* \returns true if a single interface can be identified, false otherwise.
*/
virtual bool GetIfIndexForDestination (Ipv4Address dest,
uint32_t &ifIndex) const = 0;
uint32_t &ifIndex) const = 0;
/**
* \param i index of ipv4 interface

6
src/simulator/timer.h
View File

@@ -43,6 +43,10 @@ class TimerImpl;
class Timer
{
public:
/**
* The policy to use to manager the internal timer when and
* instance of the Timer class is destroyed.
*/
enum DestroyPolicy {
/**
* This policy cancels the event from the destructor of the Timer
@@ -71,7 +75,7 @@ public:
*/
Timer ();
/**
* \param destroyFlags the event lifetime management policies to use for destroy events
* \param destroyPolicy the event lifetime management policies to use for destroy events
*/
Timer (enum DestroyPolicy destroyPolicy);
~Timer ();