SunnyQjm/ns-3-dev
1
0 Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[Doxygen] Remove inappropriate uses of @internal

Browse Source
This commit is contained in:
Peter D. Barnes, Jr. committed 2014-11-03 12:33:13 -08:00
1 parent c9cdd11ceb
commit ee641c723b
61 files changed
+54 -538
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

src/brite/helper/brite-topology-helper.h
-15
View File
@@ -231,24 +231,9 @@ private:
//stores all of the nodes used in the BRITE generated topology
NodeContainer m_nodes;
/**
* \internal
*/
void BuildBriteNodeInfoList (void);
/**
* \internal
*/
void BuildBriteEdgeInfoList (void);
/**
* \internal
*/
void ConstructTopology (void);
/**
* \internal
*/
void GenerateBriteTopology (void);
/// brite configuration file to use
src/click/helper/click-internet-stack-helper.h
-14
View File
@@ -172,7 +172,6 @@ public:
private:
/**
* @brief Enable pcap output the indicated Ipv4 and interface pair.
* @internal
*
* @param prefix Filename prefix to use for pcap files.
* @param ipv4 Ptr to the Ipv4 interface on which you want to enable tracing.
@@ -185,7 +184,6 @@ private:
/**
* @brief Enable ascii trace output on the indicated Ipv4 and interface pair.
* @internal
*
* @param stream An OutputStreamWrapper representing an existing file to use
* when writing trace data.
@@ -202,24 +200,12 @@ private:
void Initialize (void);
ObjectFactory m_tcpFactory;
/**
* \internal
*/
static void CreateAndAggregateObjectFromTypeId (Ptr<Node> node, const std::string typeId);
/**
* \internal
*/
static void Cleanup (void);
/**
* \internal
*/
bool PcapHooked (Ptr<Ipv4> ipv4);
/**
* \internal
*/
bool AsciiHooked (Ptr<Ipv4> ipv4);
/**
src/core/model/names.h
-6
View File
@@ -366,8 +366,6 @@ public:
private:
/**
* \internal
*
* \brief Non-templated internal version of Names::Find
*
* \param path A string containing the path of the object to look for.
@@ -377,8 +375,6 @@ private:
static Ptr<Object> FindInternal (std::string path);
/**
* \internal
*
* \brief Non-templated internal version of Names::Find
*
* \param path A string containing the path to search for the object in.
@@ -389,8 +385,6 @@ private:
static Ptr<Object> FindInternal (std::string path, std::string name);
/**
* \internal
*
* \brief Non-templated internal version of Names::Find
*
* \param context A smart pointer to an object under which you want to look
src/core/model/synchronizer.h
-14
View File
@@ -183,8 +183,6 @@ protected:
* @brief Establish a correspondence between a simulation time and a
* wall-clock (real) time.
*
* @internal
*
* There are three timelines involved here: the simulation time, the
* (absolute) wall-clock time and the (relative) synchronizer real time.
* Calling this method makes a correspondence between the origin of the
@@ -212,8 +210,6 @@ protected:
* @brief Return true if this synchronizer is actually synchronizing to a
* realtime clock. The simulator sometimes needs to know this.
*
* @internal
*
* Subclasses are expected to implement this method to tell the outside world
* whether or not they are synchronizing to a realtime clock.
*
@@ -225,8 +221,6 @@ protected:
* @brief Retrieve the value of the origin of the underlying normalized wall
* clock time in simulator timestep units.
*
* @internal
*
* Subclasses are expected to implement this method to do the actual
* real-time-clock-specific work of getting the current time.
*
@@ -240,8 +234,6 @@ protected:
* @brief Wait until the real time is in sync with the specified simulation
* time.
*
* @internal
*
* This is where the real work of synchronization is done. The Time passed
* in as a parameter is the simulation time. The job of Synchronize is to
* translate from simulation time to synchronizer time (in a perfect world
@@ -286,8 +278,6 @@ protected:
* @brief Declaration of method used to retrieve drift between the real time
* clock used to synchronize the simulation and the current simulation time.
*
* @internal
*
* @param ns Simulation timestep from the simulator normalized to nanosecond
* steps.
* @returns Drift in nanosecond units.
@@ -308,8 +298,6 @@ private:
* @brief Convert a simulator time step (which can be steps of time in a
* user-specified unit) to a normalized time step in nanosecond units.
*
* @internal
*
* @param ts The simulation time step to be normalized.
* @returns The simulation time step normalized to nanosecond units.
* @see TimeStepPrecision::Get
@@ -320,8 +308,6 @@ private:
* @brief Convert a normalized nanosecond count into a simulator time step
* (which can be steps of time in a user-specified unit).
*
* @internal
*
* @param ns The nanosecond count step to be converted
* @returns The simulation time step to be interpreted in appropriate units.
* @see TimeStepPrecision::Get
src/core/model/test.h
-21
View File
@@ -49,7 +49,6 @@
/**
* \ingroup testing
* \brief Check if we should assert on errors, and do so
* \internal
*/
#define ASSERT_ON_FAILURE \
do { \
@@ -62,7 +61,6 @@
/**
* \ingroup testing
* \brief If we shouldn't continue on errors, return
* \internal
*/
#define CONTINUE_ON_FAILURE \
do { \
@@ -75,7 +73,6 @@
/**
* \ingroup testing
* \brief If we shouldn't continue on errors, return test status
* \internal
*/
#define CONTINUE_ON_FAILURE_RETURNS_BOOL \
do { \
@@ -95,7 +92,6 @@
* \ingroup testing
* \brief Test that an actual and expected (limit) value are equal and report
* and abort if not.
* \internal
*/
#define NS_TEST_ASSERT_MSG_EQ_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -151,7 +147,6 @@
* \ingroup testing
* \brief Test that an actual and expected (limit) value are equal and report
* and abort if not.
* \internal
*/
#define NS_TEST_ASSERT_MSG_EQ_RETURNS_BOOL_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -213,7 +208,6 @@
*
* Required to avoid use of return statement which allows use in methods
* (esp. callbacks) returning void.
* \internal
*/
#define NS_TEST_EXPECT_MSG_EQ_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -273,7 +267,6 @@
* \ingroup testing
* \brief Test that actual and expected (limit) values are equal to plus
* or minus some tolerance and report and abort if not.
* \internal
*/
#define NS_TEST_ASSERT_MSG_EQ_TOL_INTERNAL(actual, limit, tol, msg, file, line) \
do { \
@@ -358,7 +351,6 @@
* \ingroup testing
* \brief Test that actual and expected (limit) values are equal to plus
* or minus some tolerance and report and abort if not.
* \internal
*/
#define NS_TEST_ASSERT_MSG_EQ_TOL_RETURNS_BOOL_INTERNAL(actual, limit, tol, msg, file, line) \
do { \
@@ -449,7 +441,6 @@
*
* Required to avoid use of return statement which allows use in methods
* (esp. callbacks) returning void.
* \internal
*/
#define NS_TEST_EXPECT_MSG_EQ_TOL_INTERNAL(actual, limit, tol, msg, file, line) \
do { \
@@ -537,7 +528,6 @@
* \ingroup testing
* \brief Test that an actual and expected (limit) value are not equal and
* report and abort if not.
* \internal
*/
#define NS_TEST_ASSERT_MSG_NE_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -592,7 +582,6 @@
* \ingroup testing
* \brief Test that an actual and expected (limit) value are not equal and
* report and abort if not.
* \internal
*/
#define NS_TEST_ASSERT_MSG_NE_RETURNS_BOOL_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -653,7 +642,6 @@
*
* Required to avoid use of return statement which allows use in methods
* (callbacks) returning void.
* \internal
*/
#define NS_TEST_EXPECT_MSG_NE_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -711,7 +699,6 @@
* \ingroup testing
* \brief Test that an actual value is less than a limit and report and abort
* if not.
* \internal
*/
#define NS_TEST_ASSERT_MSG_LT_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -736,7 +723,6 @@
* \ingroup testing
* \brief Test that an actual value is less than or equal to a limit and report
* and abort if not.
* \internal
*/
#define NS_TEST_ASSERT_MSG_LT_OR_EQ_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -803,7 +789,6 @@
*
* Required to avoid use of return statement which allows use in methods
* (callbacks) returning void.
* \internal
*/
#define NS_TEST_EXPECT_MSG_LT_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -830,7 +815,6 @@
*
* Required to avoid use of return statement which allows use in methods
* (callbacks) returning void.
* \internal
*/
#define NS_TEST_EXPECT_MSG_LT_OR_EQ_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -897,7 +881,6 @@
* \ingroup testing
* \brief Test that an actual value is greater than a limit and report and abort
* if not.
* \internal
*/
#define NS_TEST_ASSERT_MSG_GT_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -922,7 +905,6 @@
* \ingroup testing
* \brief Test that an actual value is greater than or equal to a limit and
* report and abort if not.
* \internal
*/
#define NS_TEST_ASSERT_MSG_GT_OR_EQ_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -989,7 +971,6 @@
*
* Required to avoid use of return statement which allows use in methods
* (callbacks) returning void.
* \internal
*/
#define NS_TEST_EXPECT_MSG_GT_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -1016,7 +997,6 @@
*
* Required to avoid use of return statement which allows use in methods
* (callbacks) returning void.
* \internal
*/
#define NS_TEST_EXPECT_MSG_GT_OR_EQ_INTERNAL(actual, limit, msg, file, line) \
do { \
@@ -1176,7 +1156,6 @@ protected:
/**
* @{
* \internal
* The methods below are used only by test macros and should not
* be used by normal users.
*/
src/core/model/unix-fd-reader.h
-3
View File
@@ -62,7 +62,6 @@ public:
protected:
/**
* \internal
* \brief A structure representing data read.
*/
struct Data
@@ -74,7 +73,6 @@ protected:
};
/**
* \internal
* \brief The read implementation.
*
* The value of \p m_len returned controls further processing. The
@@ -90,7 +88,6 @@ protected:
virtual FdReader::Data DoRead (void) = 0;
/**
* \internal
* \brief The file descriptor to read from.
*/
int m_fd;
src/core/model/wall-clock-synchronizer.h
-10
View File
@@ -75,8 +75,6 @@ protected:
* @brief Return true if this synchronizer is actually synchronizing to a
* realtime clock. The simulator sometimes needs to know this.
*
* @internal
*
* Subclasses are expected to implement this method to tell the outside world
* whether or not they are synchronizing to a realtime clock.
*
@@ -88,8 +86,6 @@ protected:
* @brief Retrieve the value of the origin of the underlying normalized wall
* clock time in nanosecond units.
*
* @internal
*
* Subclasses are expected to implement this method to do the actual
* real-time-clock-specific work of getting the current time.
*
@@ -103,8 +99,6 @@ protected:
* @brief Establish a correspondence between a simulation time and a
* wall-clock (real) time.
*
* @internal
*
* There are three timelines involved here: the simulation time, the
* (absolute) wall-clock time and the (relative) synchronizer real time.
* Calling this method makes a correspondence between the origin of the
@@ -130,8 +124,6 @@ protected:
* @brief Declaration of method used to retrieve drift between the real time
* clock used to synchronize the simulation and the current simulation time.
*
* @internal
*
* @param ns Simulation timestep from the simulator normalized to nanosecond
* steps.
* @returns Drift in nanosecond units.
@@ -145,8 +137,6 @@ protected:
* @brief Wait until the real time is in sync with the specified simulation
* time.
*
* @internal
*
* This is where the real work of synchronization is done. The Time passed
* in as a parameter is the simulation time. The job of Synchronize is to
* translate from simulation time to synchronizer time (in a perfect world
src/csma/helper/csma-helper.h
+1 -5
View File
@@ -205,14 +205,11 @@ public:
int64_t AssignStreams (NetDeviceContainer c, int64_t stream);
private:
/*
* \internal
*/
Ptr<NetDevice> InstallPriv (Ptr<Node> node, Ptr<CsmaChannel> channel) const;
/**
* \brief Enable pcap output on the indicated net device.
* \internal
*
* NetDevice-specific implementation mechanism for hooking the trace and
* writing to the trace file.
@@ -226,7 +223,6 @@ private:
/**
* \brief Enable ascii trace output on the indicated net device.
* \internal
*
* NetDevice-specific implementation mechanism for hooking the trace and
* writing to the trace file.
src/dsdv/helper/dsdv-helper.h
-1
View File
@@ -48,7 +48,6 @@ public:
DsdvHelper ();
~DsdvHelper ();
/**
* \internal
* \returns pointer to clone of this DsdvHelper
*
* This method is mainly for internal use by the other helpers;
src/dsr/helper/dsr-helper.h
-2
View File
@@ -56,7 +56,6 @@ public:
*/
DsrHelper (const DsrHelper &);
/**
* \internal
* \returns pointer to clone of this DsrHelper
*
* This method is mainly for internal use by the other helpers;
@@ -71,7 +70,6 @@ public:
void Set (std::string name, const AttributeValue &value);
private:
/**
* \internal
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
*/
src/dsr/helper/dsr-main-helper.h
-1
View File
@@ -62,7 +62,6 @@ public:
private:
void Install (Ptr<Node> node);
/**
* \internal
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
*/
src/fd-net-device/helper/emu-fd-net-device-helper.h
+3 -7
View File
@@ -62,9 +62,7 @@ public:
void SetDeviceName (std::string deviceName);
protected:
/*
* \internal
*/
Ptr<NetDevice> InstallPriv (Ptr<Node> node) const;
/**
@@ -79,10 +77,8 @@ protected:
virtual int CreateFileDescriptor (void) const;
/**
* \internal
*
* The unix/linux name of the underlying device (e.g., eth0)
*/
* The unix/linux name of the underlying device (e.g., eth0)
*/
std::string m_deviceName;
};
src/fd-net-device/helper/fd-net-device-helper.h
+1 -5
View File
@@ -90,15 +90,12 @@ public:
virtual NetDeviceContainer Install (const NodeContainer &c) const;
protected:
/*
* \internal
*/
virtual Ptr<NetDevice> InstallPriv (Ptr<Node> node) const;
private:
/**
* \brief Enable pcap output on the indicated net device.
* \internal
*
* NetDevice-specific implementation mechanism for hooking the trace and
* writing to the trace file.
@@ -112,7 +109,6 @@ private:
/**
* \brief Enable ascii trace output on the indicated net device.
* \internal
*
* NetDevice-specific implementation mechanism for hooking the trace and
* writing to the trace file.
src/fd-net-device/helper/planetlab-fd-net-device-helper.h
+5 -11
View File
@@ -66,9 +66,7 @@ public:
void SetTapMask (Ipv4Mask mask);
protected:
/*
* \internal
*/
Ptr<NetDevice> InstallPriv (Ptr<Node> node) const;
/**
@@ -83,17 +81,13 @@ protected:
virtual int CreateFileDescriptor (void) const;
/**
* \internal
*
* The IP address for the TAP device.
*/
* The IP address for the TAP device.
*/
Ipv4Address m_tapIp;
/**
* \internal
*
* The network mask for the TAP device.
*/
* The network mask for the TAP device.
*/
Ipv4Mask m_tapMask;
};
src/fd-net-device/helper/tap-fd-net-device-helper.h
+13 -29
View File
@@ -92,9 +92,7 @@ public:
void SetTapMacAddress (Mac48Address mac);
protected:
/*
* \internal
*/
Ptr<NetDevice> InstallPriv (Ptr<Node> node) const;
/**
@@ -109,47 +107,33 @@ protected:
virtual int CreateFileDescriptor (void) const;
/**
* \internal
*
* The TAP device flag IFF_NO_PI.
*/
* The TAP device flag IFF_NO_PI.
*/
bool m_modePi;
/**
* \internal
*
* The IPv4 address for the TAP device.
*/
* The IPv4 address for the TAP device.
*/
Ipv4Address m_tapIp4;
/**
* \internal
*
* The IPv6 address for the TAP device.
*/
* The IPv6 address for the TAP device.
*/
Ipv6Address m_tapIp6;
/**
* \internal
*
* The network mask IPv4 for the TAP device.
*/
* The network mask IPv4 for the TAP device.
*/
Ipv4Mask m_tapMask4;
/**
* \internal
*
* The network prefix IPv6 for the TAP device.
*/
* The network prefix IPv6 for the TAP device.
*/
int m_tapPrefix6;
/**
* \internal
*
* The TAP device MAC address.
*/
* The TAP device MAC address.
*/
Mac48Address m_tapMac;
};
src/fd-net-device/model/fd-net-device.h
-42
View File
@@ -182,29 +182,21 @@ private:
FdNetDevice (FdNetDevice const &);
/**
* \internal
*
* Spin up the device
*/
void StartDevice (void);
/**
* \internal
*
* Tear down the device
*/
void StopDevice (void);
/**
* \internal
*
* Callback to invoke when a new frame is received
*/
void ReceiveCallback (uint8_t *buf, ssize_t len);
/**
* \internal
*
* Forward the frame to the appropriate callback for processing
*/
void ForwardUp (uint8_t *buf, ssize_t len);
@@ -219,15 +211,11 @@ private:
void NotifyLinkUp (void);
/**
* \internal
*
* The ns-3 node associated to the net device.
*/
Ptr<Node> m_node;
/*
* \internal
*
* a copy of the node id so the read thread doesn't have to GetNode() in
* in order to find the node ID. Thread unsafe reference counting in
* multithreaded apps is not a good thing.
@@ -235,110 +223,80 @@ private:
uint32_t m_nodeId;
/**
* \internal
*
* The ns-3 interface index (in the sense of net device index) that has been assigned to this network device.
*/
uint32_t m_ifIndex;
/**
* \internal
*
* The MTU associated to the file descriptor technology
*/
uint16_t m_mtu;
/**
* \internal
*
* The file descriptor used for receive/send network traffic.
*/
int m_fd;
/**
* \internal
*
* Reader for the file descriptor.
*/
Ptr<FdNetDeviceFdReader> m_fdReader;
/**
* \internal
*
* The net device mac address.
*/
Mac48Address m_address;
/**
* \internal
*
* The typ of encapsulation of the received/transmited frames.
*/
EncapsulationMode m_encapMode;
/**
* \internal
*
* Flag indicating whether or not the link is up. In this case,
* whether or not the device is connected to a channel.
*/
bool m_linkUp;
/**
* \internal
*
* Callbacks to fire if the link changes state (up or down).
*/
TracedCallback<> m_linkChangeCallbacks;
/**
* \internal
*
* Flag indicating whether or not the underlying net device supports
* broadcast.
*/
bool m_isBroadcast;
/**
* \internal
*
* Flag indicating whether or not the underlying net device supports
* multicast.
*/
bool m_isMulticast;
/**
* \internal
*
* Number of packets that were received and scheduled for read but not yeat read.
*/
uint32_t m_pendingReadCount;
/**
* \internal
*
* Maximum number of packets that can be received and scheduled for read but not yeat read.
*/
uint32_t m_maxPendingReads;
/**
* \internal
*
* Mutex to increase pending read counter.
*/
SystemMutex m_pendingReadMutex;
/**
* \internal
*
* Time to start spinning up the device
*/
Time m_tStart;
/**
* \internal
*
* Time to start tearing down the device
*/
Time m_tStop;
src/internet/helper/internet-stack-helper.h
-28
View File
@@ -214,7 +214,6 @@ public:
private:
/**
* @brief Enable pcap output the indicated Ipv4 and interface pair.
* @internal
*
* @param prefix Filename prefix to use for pcap files.
* @param ipv4 Ptr to the Ipv4 interface on which you want to enable tracing.
@@ -228,7 +227,6 @@ private:
/**
* @brief Enable ascii trace output on the indicated Ipv4 and interface pair.
* @internal
*
* @param stream An OutputStreamWrapper representing an existing file to use
* when writing trace data.
@@ -245,7 +243,6 @@ private:
/**
* @brief Enable pcap output the indicated Ipv6 and interface pair.
* @internal
*
* @param prefix Filename prefix to use for pcap files.
* @param ipv6 Ptr to the Ipv6 interface on which you want to enable tracing.
@@ -259,7 +256,6 @@ private:
/**
* @brief Enable ascii trace output on the indicated Ipv6 and interface pair.
* @internal
*
* @param stream An OutputStreamWrapper representing an existing file to use
* when writing trace data.
@@ -280,40 +276,30 @@ private:
void Initialize (void);
/**
* \internal
* \brief TCP objects factory
*/
ObjectFactory m_tcpFactory;
/**
* \internal
* \brief IPv4 routing helper.
*/
const Ipv4RoutingHelper *m_routing;
/**
* \internal
* \brief IPv6 routing helper.
*/
const Ipv6RoutingHelper *m_routingv6;
/**
* \internal
*
* \brief create an object from its TypeId and aggregates it to the node
* \param node the node
* \param typeId the object TypeId
*/
static void CreateAndAggregateObjectFromTypeId (Ptr<Node> node, const std::string typeId);
/**
* \internal
*/
static void Cleanup (void);
/**
* \internal
*
* \brief checks if there is an hook to a Pcap wrapper
* \param ipv4 pointer to the IPv4 object
* \returns true if a hook is found
@@ -321,8 +307,6 @@ private:
bool PcapHooked (Ptr<Ipv4> ipv4);
/**
* \internal
*
* \brief checks if there is an hook to an ascii output stream
* \param ipv4 pointer to the IPv4 object
* \returns true if a hook is found
@@ -330,8 +314,6 @@ private:
bool AsciiHooked (Ptr<Ipv4> ipv4);
/**
* \internal
*
* \brief checks if there is an hook to a Pcap wrapper
* \param ipv6 pointer to the IPv6 object
* \returns true if a hook is found
@@ -339,8 +321,6 @@ private:
bool PcapHooked (Ptr<Ipv6> ipv6);
/**
* \internal
*
* \brief checks if there is an hook to an ascii output stream
* \param ipv6 pointer to the IPv6 object
* \returns true if a hook is found
@@ -348,29 +328,21 @@ private:
bool AsciiHooked (Ptr<Ipv6> ipv6);
/**
* \internal
*
* \brief IPv4 install state (enabled/disabled) ?
*/
bool m_ipv4Enabled;
/**
* \internal
*
* \brief IPv6 install state (enabled/disabled) ?
*/
bool m_ipv6Enabled;
/**
* \internal
*
* \brief IPv4 ARP Jitter state (enabled/disabled) ?
*/
bool m_ipv4ArpJitterEnabled;
/**
* \internal
*
* \brief IPv6 IPv6 NS and RS Jitter state (enabled/disabled) ?
*/
bool m_ipv6NsRsJitterEnabled;
src/internet/helper/internet-trace-helper.h
-24
View File
@@ -47,7 +47,6 @@ public:
/**
* @brief Enable pcap output the indicated Ipv4 and interface pair.
* @internal
*
* @param prefix Filename prefix to use for pcap files.
* @param ipv4 Ptr<Ipv4> on which you want to enable tracing.
@@ -139,7 +138,6 @@ public:
/**
* @brief Enable ascii trace output on the indicated Ipv4 and interface pair.
* @internal
*
* The implementation is expected to use a provided Ptr<OutputStreamWrapper>
* if it is non-null. If the OutputStreamWrapper is null, the implementation
@@ -299,8 +297,6 @@ public:
private:
/**
* @internal
*
* @brief Enable ascii trace output on the Ipv4 and interface pair specified by a
* global node-id (of a previously created node) and interface. Since there
* can be only one Ipv4 aggregated to a node, the node-id unambiguously
@@ -322,8 +318,6 @@ private:
bool explicitFilename);
/**
* @internal
*
* @brief Enable ascii trace output on the Ipv4 and interface pair specified by a
* global node-id (of a previously created node) and interface. Since there
* can be only one Ipv4 aggregated to a node, the node-id unambiguously
@@ -337,8 +331,6 @@ private:
void EnableAsciiIpv4Impl (Ptr<OutputStreamWrapper> stream, std::string prefix, NodeContainer n);
/**
* @internal
*
* @brief Enable ascii trace output on the Ipv4 and interface pair specified by a
* global node-id (of a previously created node) and interface. Since there
* can be only one Ipv4 aggregated to a node, the node-id unambiguously
@@ -352,8 +344,6 @@ private:
void EnableAsciiIpv4Impl (Ptr<OutputStreamWrapper> stream, std::string prefix, Ipv4InterfaceContainer c);
/**
* @internal
*
* @brief Enable ascii trace output on the Ipv4 and interface pair specified by a
* global node-id (of a previously created node) and interface. Since there
* can be only one Ipv4 aggregated to a node, the node-id unambiguously
@@ -374,8 +364,6 @@ private:
bool explicitFilename);
/**
* @internal
*
* @brief Enable ascii trace output on the Ipv4 and interface pair specified by a
* global node-id (of a previously created node) and interface. Since there
* can be only one Ipv4 aggregated to a node, the node-id unambiguously
@@ -415,7 +403,6 @@ public:
/**
* @brief Enable pcap output the indicated Ipv6 and interface pair.
* @internal
*
* @param prefix Filename prefix to use for pcap files.
* @param ipv6 Ptr<Ipv6> on which you want to enable tracing.
@@ -506,7 +493,6 @@ public:
/**
* @brief Enable ascii trace output on the indicated Ipv6 and interface pair.
* @internal
*
* The implementation is expected to use a provided Ptr<OutputStreamWrapper>
* if it is non-null. If the OutputStreamWrapper is null, the implementation
@@ -665,8 +651,6 @@ public:
private:
/**
* @internal
*
* @brief Enable ascii trace output on the Ipv6 and interface pair specified by a
* global node-id (of a previously created node) and interface. Since there
* can be only one Ipv6 aggregated to a node, the node-id unambiguously
@@ -688,8 +672,6 @@ private:
bool explicitFilename);
/**
* @internal
*
* @brief Enable ascii trace output on the Ipv6 and interface pair specified by a
* global node-id (of a previously created node) and interface. Since there
* can be only one Ipv6 aggregated to a node, the node-id unambiguously
@@ -703,8 +685,6 @@ private:
void EnableAsciiIpv6Impl (Ptr<OutputStreamWrapper> stream, std::string prefix, NodeContainer n);
/**
* @internal
*
* @brief Enable ascii trace output on the Ipv6 and interface pair specified by a
* global node-id (of a previously created node) and interface. Since there
* can be only one Ipv6 aggregated to a node, the node-id unambiguously
@@ -718,8 +698,6 @@ private:
void EnableAsciiIpv6Impl (Ptr<OutputStreamWrapper> stream, std::string prefix, Ipv6InterfaceContainer c);
/**
* @internal
*
* @brief Enable ascii trace output on the Ipv6 and interface pair specified by a
* global node-id (of a previously created node) and interface. Since there
* can be only one Ipv6 aggregated to a node, the node-id unambiguously
@@ -740,8 +718,6 @@ private:
bool explicitFilename);
/**
* @internal
*
* @brief Enable ascii trace output on the Ipv6 and interface pair specified by a
* global node-id (of a previously created node) and interface. Since there
* can be only one Ipv6 aggregated to a node, the node-id unambiguously
src/internet/helper/ipv4-address-helper.h
-1
View File
@@ -180,7 +180,6 @@ public:
private:
/**
* @internal
* \brief Returns the number of address bits (hostpart) for a given netmask
* \param maskbits the netmask
* \returns the number of bits in the hostpart
src/internet/helper/ipv4-global-routing-helper.h
-2
View File
@@ -44,7 +44,6 @@ public:
Ipv4GlobalRoutingHelper (const Ipv4GlobalRoutingHelper &);
/**
* \internal
* \returns pointer to clone of this Ipv4GlobalRoutingHelper
*
* This method is mainly for internal use by the other helpers;
@@ -85,7 +84,6 @@ public:
static void RecomputeRoutingTables (void);
private:
/**
* \internal
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
* \return
src/internet/helper/ipv4-interface-container.h
-2
View File
@@ -180,13 +180,11 @@ public:
private:
/**
* \internal
* \brief Container for pairs of Ipv4 smart pointer / Interface Index.
*/
typedef std::vector<std::pair<Ptr<Ipv4>,uint32_t> > InterfaceVector;
/**
* \internal
* \brief List of IPv4 stack and interfaces index.
*/
InterfaceVector m_interfaces;
src/internet/helper/ipv4-list-routing-helper.h
-4
View File
@@ -42,7 +42,6 @@ public:
Ipv4ListRoutingHelper ();
/*
* \internal
* Destroy an Ipv4ListRoutingHelper.
*/
virtual ~Ipv4ListRoutingHelper ();
@@ -54,7 +53,6 @@ public:
Ipv4ListRoutingHelper (const Ipv4ListRoutingHelper &);
/**
* \internal
* \returns pointer to clone of this Ipv4ListRoutingHelper
*
* This method is mainly for internal use by the other helpers;
@@ -82,7 +80,6 @@ public:
virtual Ptr<Ipv4RoutingProtocol> Create (Ptr<Node> node) const;
private:
/**
* \internal
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
* \return
@@ -90,7 +87,6 @@ private:
Ipv4ListRoutingHelper &operator = (const Ipv4ListRoutingHelper &);
/**
* \internal
* \brief Container for pairs of Ipv4RoutingHelper pointer / priority.
*/
std::list<std::pair<const Ipv4RoutingHelper *,int16_t> > m_list;
src/internet/helper/ipv4-routing-helper.h
-8
View File
@@ -185,8 +185,6 @@ public:
private:
/**
* \internal
*
* \brief prints the routing tables of a node.
* \param node The node ptr for which we need the routing table to be printed
* \param stream The output stream object to use
@@ -198,8 +196,6 @@ private:
static void Print (Ptr<Node> node, Ptr<OutputStreamWrapper> stream);
/**
* \internal
*
* \brief prints the routing tables of a node at regular intervals specified by user.
* \param printInterval the time interval for which the routing table is supposed to be printed.
* \param node The node ptr for which we need the routing table to be printed
@@ -212,8 +208,6 @@ private:
static void PrintEvery (Time printInterval, Ptr<Node> node, Ptr<OutputStreamWrapper> stream);
/**
* \internal
*
* \brief prints the neighbor cache of a node.
* \param node The node ptr for which we need the neighbor cache to be printed
* \param stream The output stream object to use
@@ -229,8 +223,6 @@ private:
static void PrintArpCache (Ptr<Node> node, Ptr<OutputStreamWrapper> stream);
/**
* \internal
*
* \brief prints the neighbor cache of a node at regular intervals specified by user.
* \param printInterval the time interval for which the neighbor cache is supposed to be printed.
* \param node The node ptr for which we need the neighbor cache to be printed
src/internet/helper/ipv4-static-routing-helper.h
-2
View File
@@ -53,7 +53,6 @@ public:
Ipv4StaticRoutingHelper (const Ipv4StaticRoutingHelper &);
/**
* \internal
* \returns pointer to clone of this Ipv4StaticRoutingHelper
*
* This method is mainly for internal use by the other helpers;
@@ -158,7 +157,6 @@ public:
void SetDefaultMulticastRoute (std::string nName, std::string ndName);
private:
/**
* \internal
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
* \returns
src/internet/helper/ipv6-interface-container.h
-2
View File
@@ -203,13 +203,11 @@ public:
private:
/**
* \internal
* \brief Container for pairs of Ipv6 smart pointer / Interface Index.
*/
typedef std::vector<std::pair<Ptr<Ipv6>, uint32_t> > InterfaceVector;
/**
* \internal
* \brief List of IPv6 stack and interfaces index.
*/
InterfaceVector m_interfaces;
src/internet/helper/ipv6-list-routing-helper.h
-3
View File
@@ -44,7 +44,6 @@ public:
Ipv6ListRoutingHelper ();
/**
* \internal
* \brief Destroy an Ipv6 Ipv6ListRoutingHelper.
*/
virtual ~Ipv6ListRoutingHelper ();
@@ -83,7 +82,6 @@ public:
virtual Ptr<Ipv6RoutingProtocol> Create (Ptr<Node> node) const;
private:
/**
* \internal
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
* \param o object to copy from
@@ -92,7 +90,6 @@ private:
Ipv6ListRoutingHelper &operator = (const Ipv6ListRoutingHelper &o);
/**
* \internal
* \brief Container for pairs of Ipv6RoutingHelper pointer / priority.
*/
std::list<std::pair<const Ipv6RoutingHelper *,int16_t> > m_list;
src/internet/helper/ipv6-routing-helper.h
-9
View File
@@ -45,7 +45,6 @@ class Ipv6RoutingHelper
public:
/**
* \internal
* \brief Destroy an Ipv6 Ipv6RoutingHelper.
*/
virtual ~Ipv6RoutingHelper ();
@@ -187,8 +186,6 @@ public:
private:
/**
* \internal
*
* \brief prints the routing tables of a node.
* \param node The node ptr for which we need the routing table to be printed
* \param stream The output stream object to use
@@ -200,8 +197,6 @@ private:
static void Print (Ptr<Node> node, Ptr<OutputStreamWrapper> stream);
/**
* \internal
*
* \brief prints the routing tables of a node at regular intervals specified by user.
* \param printInterval the time interval for which the routing table is supposed to be printed.
* \param node The node ptr for which we need the routing table to be printed
@@ -214,8 +209,6 @@ private:
static void PrintEvery (Time printInterval, Ptr<Node> node, Ptr<OutputStreamWrapper> stream);
/**
* \internal
*
* \brief prints the neighbor cache of a node.
* \param node The node ptr for which we need the neighbor cache to be printed
* \param stream The output stream object to use
@@ -231,8 +224,6 @@ private:
static void PrintNdiscCache (Ptr<Node> node, Ptr<OutputStreamWrapper> stream);
/**
* \internal
*
* \brief prints the neighbor cache of a node at regular intervals specified by user.
* \param printInterval the time interval for which the neighbor cache is supposed to be printed.
* \param node The node ptr for which we need the neighbor cache to be printed
src/internet/helper/ipv6-static-routing-helper.h
-2
View File
@@ -53,7 +53,6 @@ public:
Ipv6StaticRoutingHelper (const Ipv6StaticRoutingHelper &);
/**
* \internal
* \returns pointer to clone of this Ipv6StaticRoutingHelper
*
* This method is mainly for internal use by the other helpers;
@@ -118,7 +117,6 @@ public:
#endif
private:
/**
* \internal
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
* \param o object to copy from
src/internet/model/candidate-queue.h
+1 -11
View File
@@ -51,16 +51,14 @@ class CandidateQueue
public:
/**
* @brief Create an empty SPF Candidate Queue.
* @internal
*
* @see SPFVertex
*/
CandidateQueue ();
/**
* @internal Destroy an SPF Candidate Queue and release any resources held
* @brief Destroy an SPF Candidate Queue and release any resources held
* by the contents.
* @internal
*
* @see SPFVertex
*/
@@ -69,7 +67,6 @@ public:
/**
* @brief Empty the Candidate Queue and release all of the resources
* associated with the Shortest Path First Vertex pointers in the queue.
* @internal
*
* @see SPFVertex
*/
@@ -78,7 +75,6 @@ public:
/**
* @brief Push a Shortest Path First Vertex pointer onto the queue according
* to the priority scheme.
* @internal
*
* On completion, the top of the queue will hold the Shortest Path First
* Vertex pointer that points to a vertex having lowest value of the field
@@ -92,7 +88,6 @@ public:
/**
* @brief Pop the Shortest Path First Vertex pointer at the top of the queue.
* @internal
*
* The caller is given the responsibility for releasing the resources
* associated with the vertex.
@@ -106,7 +101,6 @@ public:
/**
* @brief Return the Shortest Path First Vertex pointer at the top of the
* queue.
* @internal
*
* This method does not pop the SPFVertex* off of the queue, it simply
* returns the pointer.
@@ -119,7 +113,6 @@ public:
/**
* @brief Test the Candidate Queue to determine if it is empty.
* @internal
*
* @returns True if the queue is empty, false otherwise.
*/
@@ -128,7 +121,6 @@ public:
/**
* @brief Return the number of Shortest Path First Vertex pointers presently
* stored in the Candidate Queue.
* @internal
*
* @see SPFVertex
* @returns The number of SPFVertex* pointers in the Candidate Queue.
@@ -138,7 +130,6 @@ public:
/**
* @brief Searches the Candidate Queue for a Shortest Path First Vertex
* pointer that points to a vertex having the given IP address.
* @internal
*
* @see SPFVertex
* @param addr The IP address to search for.
@@ -148,7 +139,6 @@ public:
/**
* @brief Reorders the Candidate Queue according to the priority scheme.
* @internal
*
* On completion, the top of the queue will hold the Shortest Path First
* Vertex pointer that points to a vertex having lowest value of the field
src/internet/model/global-route-manager-impl.h
-33
View File
@@ -68,7 +68,6 @@ class SPFVertex
public:
/**
* @brief Enumeration of the possible types of SPFVertex objects.
* @internal
*
* Currently we use VertexRouter to identify objects that represent a router
* in the simulation topology, and VertexNetwork to identify objects that
@@ -83,7 +82,6 @@ public:
/**
* @brief Construct an empty ("uninitialized") SPFVertex (Shortest Path First
* Vertex).
* @internal
*
* The Vertex Type is set to VertexUnknown, the Vertex ID is set to
* 255.255.255.255, and the distance from root is set to infinity
@@ -98,7 +96,6 @@ public:
/**
* @brief Construct an initialized SPFVertex (Shortest Path First Vertex).
* @internal
*
* The Vertex Type is initialized to VertexRouter and the Vertex ID is found
* from the Link State ID of the Link State Advertisement (LSA) passed as a
@@ -116,7 +113,6 @@ public:
/**
* @brief Destroy an SPFVertex (Shortest Path First Vertex).
* @internal
*
* The children vertices of the SPFVertex are recursively deleted.
*
@@ -126,7 +122,6 @@ public:
/**
* @brief Get the Vertex Type field of a SPFVertex object.
* @internal
*
* The Vertex Type describes the kind of simulation object a given SPFVertex
* represents.
@@ -138,7 +133,6 @@ public:
/**
* @brief Set the Vertex Type field of a SPFVertex object.
* @internal
*
* The Vertex Type describes the kind of simulation object a given SPFVertex
* represents.
@@ -150,7 +144,6 @@ public:
/**
* @brief Get the Vertex ID field of a SPFVertex object.
* @internal
*
* The Vertex ID uniquely identifies the simulation object a given SPFVertex
* represents. Typically, this is the Router ID for SPFVertex objects
@@ -166,7 +159,6 @@ public:
/**
* @brief Set the Vertex ID field of a SPFVertex object.
* @internal
*
* The Vertex ID uniquely identifies the simulation object a given SPFVertex
* represents. Typically, this is the Router ID for SPFVertex objects
@@ -185,7 +177,6 @@ public:
* @brief Get the Global Router Link State Advertisement returned by the
* Global Router represented by this SPFVertex during the route discovery
* process.
* @internal
*
* @see GlobalRouter
* @see GlobalRoutingLSA
@@ -199,7 +190,6 @@ public:
* @brief Set the Global Router Link State Advertisement returned by the
* Global Router represented by this SPFVertex during the route discovery
* process.
* @internal
*
* @see SPFVertex::GetLSA ()
* @see GlobalRouter
@@ -213,7 +203,6 @@ public:
/**
* @brief Get the distance from the root vertex to "this" SPFVertex object.
* @internal
*
* Each router in the simulation is associated with an SPFVertex object. When
* calculating routes, each of these routers is, in turn, chosen as the "root"
@@ -236,7 +225,6 @@ public:
/**
* @brief Set the distance from the root vertex to "this" SPFVertex object.
* @internal
*
* Each router in the simulation is associated with an SPFVertex object. When
* calculating routes, each of these routers is, in turn, chosen as the "root"
@@ -258,7 +246,6 @@ public:
/**
* @brief Set the IP address and outgoing interface index that should be used
* to begin forwarding packets from the root SPFVertex to "this" SPFVertex.
* @internal
*
* Each router node in the simulation is associated with an SPFVertex object.
* When calculating routes, each of these routers is, in turn, chosen as the
@@ -304,7 +291,6 @@ public:
/**
* @brief Set the IP address and outgoing interface index that should be used
* to begin forwarding packets from the root SPFVertex to "this" SPFVertex.
* @internal
*
* Each router node in the simulation is associated with an SPFVertex object.
* When calculating routes, each of these routers is, in turn, chosen as the
@@ -388,7 +374,6 @@ public:
/**
* @brief Get a pointer to the SPFVector that is the parent of "this"
* SPFVertex.
* @internal
*
* Each router node in the simulation is associated with an SPFVertex object.
* When calculating routes, each of these routers is, in turn, chosen as the
@@ -410,7 +395,6 @@ public:
/**
* @brief Set the pointer to the SPFVector that is the parent of "this"
* SPFVertex.
* @internal
*
* Each router node in the simulation is associated with an SPFVertex object.
* When calculating routes, each of these routers is, in turn, chosen as the
@@ -438,7 +422,6 @@ public:
/**
* @brief Get the number of children of "this" SPFVertex.
* @internal
*
* Each router node in the simulation is associated with an SPFVertex object.
* When calculating routes, each of these routers is, in turn, chosen as the
@@ -461,7 +444,6 @@ public:
/**
* @brief Get a borrowed SPFVertex pointer to the specified child of "this"
* SPFVertex.
* @internal
*
* Each router node in the simulation is associated with an SPFVertex object.
* When calculating routes, each of these routers is, in turn, chosen as the
@@ -490,7 +472,6 @@ public:
/**
* @brief Get a borrowed SPFVertex pointer to the specified child of "this"
* SPFVertex.
* @internal
*
* Each router node in the simulation is associated with an SPFVertex object.
* When calculating routes, each of these routers is, in turn, chosen as the
@@ -599,7 +580,6 @@ class GlobalRouteManagerLSDB
public:
/**
* @brief Construct an empty Global Router Manager Link State Database.
* @internal
*
* The database map composing the Link State Database is initialized in
* this constructor.
@@ -608,7 +588,6 @@ public:
/**
* @brief Destroy an empty Global Router Manager Link State Database.
* @internal
*
* The database map is walked and all of the Link State Advertisements stored
* in the database are freed; then the database map itself is clear ()ed to
@@ -619,7 +598,6 @@ public:
/**
* @brief Insert an IP address / Link State Advertisement pair into the Link
* State Database.
* @internal
*
* The IPV4 address and the GlobalRoutingLSA given as parameters are converted
* to an STL pair and are inserted into the database map.
@@ -635,7 +613,6 @@ public:
/**
* @brief Look up the Link State Advertisement associated with the given
* link state ID (address).
* @internal
*
* The database map is searched for the given IPV4 address and corresponding
* GlobalRoutingLSA is returned.
@@ -653,7 +630,6 @@ public:
* link state ID (address). This is a variation of the GetLSA call
* to allow the LSA to be found by matching addr with the LinkData field
* of the TransitNetwork link record.
* @internal
*
* @see GetLSA
* @param addr The IP address associated with the LSA. Typically the Router
@@ -665,7 +641,6 @@ public:
/**
* @brief Set all LSA flags to an initialized state, for SPF computation
* @internal
*
* This function walks the database and resets the status flags of all of the
* contained Link State Advertisements to LSA_SPF_NOT_EXPLORED. This is done
@@ -680,7 +655,6 @@ public:
/**
* @brief Look up the External Link State Advertisement associated with the given
* index.
* @internal
*
* The external database map is searched for the given index and corresponding
* GlobalRoutingLSA is returned.
@@ -692,7 +666,6 @@ public:
GlobalRoutingLSA* GetExtLSA (uint32_t index) const;
/**
* @brief Get the number of External Link State Advertisements.
* @internal
*
* @see GlobalRoutingLSA
* @returns the number of External Link State Advertisements.
@@ -745,34 +718,28 @@ public:
*
* \todo separate manually assigned static routes from static routes that
* the global routing code injects, and only delete the latter
* @internal
*
*/
virtual void DeleteGlobalRoutes ();
/**
* @brief Build the routing database by gathering Link State Advertisements
* from each node exporting a GlobalRouter interface.
* @internal
*/
virtual void BuildGlobalRoutingDatabase ();
/**
* @brief Compute routes using a Dijkstra SPF computation and populate
* per-node forwarding tables
* @internal
*/
virtual void InitializeRoutes ();
/**
* @brief Debugging routine; allow client code to supply a pre-built LSDB
* @internal
*/
void DebugUseLsdb (GlobalRouteManagerLSDB*);
/**
* @brief Debugging routine; call the core SPF from the unit tests
* @internal
* @param root the root node to start calculations
*/
void DebugSPFCalculate (Ipv4Address root);
src/internet/model/global-route-manager.h
-3
View File
@@ -53,15 +53,12 @@ public:
/**
* @brief Build the routing database by gathering Link State Advertisements
* from each node exporting a GlobalRouter interface.
* @internal
*
*/
static void BuildGlobalRoutingDatabase ();
/**
* @brief Compute routes using a Dijkstra SPF computation and populate
* per-node forwarding tables
* @internal
*/
static void InitializeRoutes ();
src/internet/model/ipv4-address-generator.cc
+12 -25
View File
@@ -28,7 +28,6 @@ namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Ipv4AddressGenerator");
/**
* \internal
* \ingroup address
*
* \brief Implementation class of Ipv4AddressGenerator
@@ -43,7 +42,6 @@ public:
virtual ~Ipv4AddressGeneratorImpl ();
/**
* \internal
* \brief Initialise the base network, mask and address for the generator
*
* The first call to NextAddress() or GetAddress() will return the
@@ -57,7 +55,6 @@ public:
const Ipv4Address addr);
/**
* \internal
* \brief Get the current network of the given Ipv4Mask
*
* Does not change the internal state; this just peeks at the current
@@ -69,7 +66,6 @@ public:
Ipv4Address GetNetwork (const Ipv4Mask mask) const;
/**
* \internal
* \brief Get the next network according to the given Ipv4Mask
*
* This operation is a pre-increment, meaning that the internal state
@@ -84,7 +80,6 @@ public:
Ipv4Address NextNetwork (const Ipv4Mask mask);
/**
* \internal
* \brief Set the address for the given mask
*
* \param addr The address to set for the current mask
@@ -93,7 +88,6 @@ public:
void InitAddress (const Ipv4Address addr, const Ipv4Mask mask);
/**
* \internal
* \brief Allocate the next Ipv4Address for the configured network and mask
*
* This operation is a post-increment, meaning that the first address
@@ -105,7 +99,6 @@ public:
Ipv4Address NextAddress (const Ipv4Mask mask);
/**
* \internal
* \brief Get the Ipv4Address that will be allocated upon NextAddress ()
*
* Does not change the internal state; just is used to peek the next
@@ -117,13 +110,11 @@ public:
Ipv4Address GetAddress (const Ipv4Mask mask) const;
/**
* \internal
* \brief Reset the networks and Ipv4Address to zero
*/
void Reset (void);
/**
* \internal
* \brief Add the Ipv4Address to the list of IPv4 entries
*
* Typically, this is used by external address allocators that want
@@ -136,16 +127,14 @@ public:
bool AddAllocated (const Ipv4Address addr);
/**
* \internal
* \brief Used to turn off fatal errors and assertions, for testing
*/
void TestMode (void);
private:
static const uint32_t N_BITS = 32; //!< /internal the number of bits in the address
static const uint32_t MOST_SIGNIFICANT_BIT = 0x80000000; //!< /internal MSB set to 1
static const uint32_t N_BITS = 32; //!< the number of bits in the address
static const uint32_t MOST_SIGNIFICANT_BIT = 0x80000000; //!< MSB set to 1
/**
* \internal
* \brief Create an index number for the network mask
* \param mask the mask to index
* \returns an index
@@ -153,34 +142,32 @@ private:
uint32_t MaskToIndex (Ipv4Mask mask) const;
/**
* \internal
* \brief This class holds the state for a given network
*/
class NetworkState
{
public:
uint32_t mask; //!< /internal the network mask
uint32_t shift; //!< /internal a shift
uint32_t network; //!< /internal the network
uint32_t addr; //!< /internal the address
uint32_t addrMax; //!< /internal the maximum address
uint32_t mask; //!< the network mask
uint32_t shift; //!< a shift
uint32_t network; //!< the network
uint32_t addr; //!< the address
uint32_t addrMax; //!< the maximum address
};
NetworkState m_netTable[N_BITS]; //!< /internal the available networks
NetworkState m_netTable[N_BITS]; //!< the available networks
/**
* \internal
* \brief This class holds the allocated addresses
*/
class Entry
{
public:
uint32_t addrLow; //!< /internal the lowest allocated address
uint32_t addrHigh; //!< /internal the highest allocated address
uint32_t addrLow; //!< the lowest allocated address
uint32_t addrHigh; //!< the highest allocated address
};
std::list<Entry> m_entries; //!< /internal contained of allocated addresses
bool m_test; //!< /internal test mode (if true)
std::list<Entry> m_entries; //!< contained of allocated addresses
bool m_test; //!< test mode (if true)
};
Ipv4AddressGeneratorImpl::Ipv4AddressGeneratorImpl ()
src/internet/model/ipv4-packet-probe.h
-2
View File
@@ -101,8 +101,6 @@ private:
* \param packet the traced packet
* \param ipv4 the IPv4 object for the traced packet
* \param interface the IPv4 interface for the traced packet
*
* \internal
*/
void TraceSink (Ptr<const Packet> packet, Ptr<Ipv4> ipv4, uint32_t interface);
src/internet/model/ipv6-address-generator.cc
+13 -26
View File
@@ -29,7 +29,6 @@ namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Ipv6AddressGenerator");
/**
* \internal
* \ingroup address
*
* \brief Implementation class of Ipv6AddressGenerator
@@ -45,7 +44,6 @@ public:
virtual ~Ipv6AddressGeneratorImpl ();
/**
* \internal
* \brief Initialise the base network and interfaceId for the generator
*
* The first call to NextAddress() or GetAddress() will return the
@@ -59,7 +57,6 @@ public:
const Ipv6Address interfaceId);
/**
* \internal
* \brief Get the next network according to the given Ipv6Prefix
*
* This operation is a pre-increment, meaning that the internal state
@@ -74,7 +71,6 @@ public:
Ipv6Address NextNetwork (const Ipv6Prefix prefix);
/**
* \internal
* \brief Get the current network of the given Ipv6Prefix
*
* Does not change the internal state; this just peeks at the current
@@ -86,7 +82,6 @@ public:
Ipv6Address GetNetwork (const Ipv6Prefix prefix) const;
/**
* \internal
* \brief Set the interfaceId for the given Ipv6Prefix
*
* \param interfaceId The interfaceId to set for the current Ipv6Prefix
@@ -95,7 +90,6 @@ public:
void InitAddress (const Ipv6Address interfaceId, const Ipv6Prefix prefix);
/**
* \internal
* \brief Get the Ipv6Address that will be allocated upon NextAddress ()
*
* Does not change the internal state; just is used to peek the next
@@ -107,7 +101,6 @@ public:
Ipv6Address GetAddress (const Ipv6Prefix prefix) const;
/**
* \internal
* \brief Allocate the next Ipv6Address for the configured network and prefix
*
* This operation is a post-increment, meaning that the first address
@@ -119,13 +112,11 @@ public:
Ipv6Address NextAddress (const Ipv6Prefix prefix);
/**
* \internal
* \brief Reset the networks and Ipv6Address to zero
*/
void Reset (void);
/**
* \internal
* \brief Add the Ipv6Address to the list of IPv6 entries
*
* Typically, this is used by external address allocators that want
@@ -138,17 +129,15 @@ public:
bool AddAllocated (const Ipv6Address addr);
/**
* \internal
* \brief Used to turn off fatal errors and assertions, for testing
*/
void TestMode (void);
private:
static const uint32_t N_BITS = 128; //!< /internal the number of bits in the address
static const uint32_t MOST_SIGNIFICANT_BIT = 0x80; //!< /internal MSB set to 1
static const uint32_t N_BITS = 128; //!< the number of bits in the address
static const uint32_t MOST_SIGNIFICANT_BIT = 0x80; //!< MSB set to 1
/**
* \internal
* \brief Create an index number for the prefix
* \param prefix the prefix to index
* \returns an index
@@ -156,35 +145,33 @@ private:
uint32_t PrefixToIndex (Ipv6Prefix prefix) const;
/**
* \internal
* \brief This class holds the state for a given network
*/
class NetworkState
{
public:
uint8_t prefix[16]; //!< /internal the network prefix
uint32_t shift; //!< /internal a shift
uint8_t network[16]; //!< /internal the network
uint8_t addr[16]; //!< /internal the address
uint8_t addrMax[16]; //!< /internal the maximum address
uint8_t prefix[16]; //!< the network prefix
uint32_t shift; //!< a shift
uint8_t network[16]; //!< the network
uint8_t addr[16]; //!< the address
uint8_t addrMax[16]; //!< the maximum address
};
NetworkState m_netTable[N_BITS]; //!< /internal the available networks
NetworkState m_netTable[N_BITS]; //!< the available networks
/**
* \internal
* \brief This class holds the allocated addresses
*/
class Entry
{
public:
uint8_t addrLow[16]; //!< /internal the lowest allocated address
uint8_t addrHigh[16]; //!< /internal the highest allocated address
uint8_t addrLow[16]; //!< the lowest allocated address
uint8_t addrHigh[16]; //!< the highest allocated address
};
std::list<Entry> m_entries; //!< /internal contained of allocated addresses
Ipv6Address m_base; //!< /internal base address
bool m_test; //!< /internal test mode (if true)
std::list<Entry> m_entries; //!< contained of allocated addresses
Ipv6Address m_base; //!< base address
bool m_test; //!< test mode (if true)
};
Ipv6AddressGeneratorImpl::Ipv6AddressGeneratorImpl ()
src/internet/model/ipv6-packet-probe.h
-2
View File
@@ -103,8 +103,6 @@ private:
* \param packet the traced packet
* \param ipv6 the IPv6 object for the traced packet
* \param interface the IPv6 interface for the traced packet
*
* \internal
*/
void TraceSink (Ptr<const Packet> packet, Ptr<Ipv6> ipv6, uint32_t interface);
src/internet/model/udp-socket-factory-impl.h
-2
View File
@@ -46,7 +46,6 @@ class UdpL4Protocol;
/**
* \ingroup udp
* \brief Object to create UDP socket instances
* \internal
*
* This class implements the API for creating UDP sockets.
* It is a socket factory (deriving from class SocketFactory).
@@ -66,7 +65,6 @@ public:
/**
* \brief Implements a method to create a Udp-based socket and return
* a base class smart pointer to the socket.
* \internal
*
* \return smart pointer to Socket
*/
src/lr-wpan/helper/lr-wpan-helper.h
-4
View File
@@ -118,10 +118,7 @@ private:
*/
LrWpanHelper& operator= (LrWpanHelper const &);
/**
* \internal
*
* \brief Enable pcap output on the indicated net device.
* \internal
*
* NetDevice-specific implementation mechanism for hooking the trace and
* writing to the trace file.
@@ -135,7 +132,6 @@ private:
/**
* \brief Enable ascii trace output on the indicated net device.
* \internal
*
* NetDevice-specific implementation mechanism for hooking the trace and
* writing to the trace file.
src/mesh/helper/dot11s/dot11s-installer.h
+1 -3
View File
@@ -31,9 +31,7 @@ namespace ns3 {
class Dot11sStack : public MeshStack
{
public:
/**
* \internal
*/
static TypeId GetTypeId ();
/**
src/mesh/helper/flame/flame-installer.h
+1 -4
View File
@@ -34,9 +34,7 @@ namespace ns3 {
class FlameStack : public MeshStack
{
public:
/*
* \internal
*/
static TypeId GetTypeId ();
/**
@@ -50,7 +48,6 @@ public:
~FlameStack ();
/**
* \internal
* Break any reference cycles in the installer helper. Required for ns-3
* Object support.
*/
src/mesh/helper/mesh-helper.h
-1
View File
@@ -206,7 +206,6 @@ public:
private:
/**
* \internal
* \returns a WifiNetDevice with ready-to-use interface
*/
Ptr<WifiNetDevice> CreateInterface (const WifiPhyHelper &phyHelper, Ptr<Node> node, uint16_t channelId) const;
src/mobility/helper/mobility-helper.h
+1 -4
View File
@@ -49,7 +49,6 @@ public:
MobilityHelper ();
/**
* \internal
* Destroy a Mobility Helper
*/
~MobilityHelper ();
@@ -262,9 +261,7 @@ public:
int64_t AssignStreams (NodeContainer c, int64_t stream);
private:
/**
* \internal
*/
static void CourseChanged (Ptr<OutputStreamWrapper> stream, Ptr<const MobilityModel> mobility);
std::vector<Ptr<MobilityModel> > m_mobilityStack;
ObjectFactory m_mobility;
src/network/helper/trace-helper.h
+1 -5
View File
@@ -544,7 +544,6 @@ public:
/**
* @brief Enable pcap output the indicated net device.
* @internal
*
* @param prefix Filename prefix to use for pcap files.
* @param nd Net device for which you want to enable tracing.
@@ -634,7 +633,6 @@ public:
/**
* @brief Enable ascii trace output on the indicated net device.
* @internal
*
* The implementation is expected to use a provided Ptr<OutputStreamWrapper>
* if it is non-null. If the OutputStreamWrapper is null, the implementation
@@ -794,9 +792,7 @@ private:
* ascii tracing
* @param explicitFilename Treat the prefix as an explicit filename if true
*/
/**
* @internal Avoid code duplication.
*/
void EnableAsciiImpl (Ptr<OutputStreamWrapper> stream,
std::string prefix,
uint32_t nodeid,
src/network/model/packet-metadata.h
-1
View File
@@ -36,7 +36,6 @@ class Header;
class Trailer;
/**
* \internal
* \ingroup packet
* \brief Handle packet metadata about packet headers and trailers
*
src/network/utils/packet-probe.h
-2
View File
@@ -95,8 +95,6 @@ private:
* arguments of type Ptr<const Packet>
*
* \param packet the traced packet
*
* \internal
*/
void TraceSink (Ptr<const Packet> packet);
src/nix-vector-routing/helper/ipv4-nix-vector-helper.h
-2
View File
@@ -49,7 +49,6 @@ public:
Ipv4NixVectorHelper (const Ipv4NixVectorHelper &);
/**
* \internal
* \returns pointer to clone of this Ipv4NixVectorHelper
*
* This method is mainly for internal use by the other helpers;
@@ -67,7 +66,6 @@ public:
private:
/**
* \internal
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
*/
src/olsr/helper/olsr-helper.h
-2
View File
@@ -51,7 +51,6 @@ public:
OlsrHelper (const OlsrHelper &);
/**
* \internal
* \returns pointer to clone of this OlsrHelper
*
* This method is mainly for internal use by the other helpers;
@@ -98,7 +97,6 @@ public:
private:
/**
* \internal
* \brief Assignment operator declared private and not implemented to disallow
* assignment and prevent the compiler from happily inserting its own.
*/
src/openflow/model/openflow-interface.h
-6
View File
@@ -398,8 +398,6 @@ public:
protected:
/**
* \internal
*
* However the controller is implemented, this method is to
* be used to pass a message on to a switch.
*
@@ -410,8 +408,6 @@ protected:
virtual void SendToSwitch (Ptr<OpenFlowSwitchNetDevice> swtch, void * msg, size_t length);
/**
* \internal
*
* Construct flow data from a matching key to build a flow
* entry for adding, modifying, or deleting a flow.
*
@@ -427,8 +423,6 @@ protected:
ofp_flow_mod* BuildFlow (sw_flow_key key, uint32_t buffer_id, uint16_t command, void* acts, size_t actions_len, int idle_timeout, int hard_timeout);
/**
* \internal
*
* Get the packet type on the buffer, which can then be used
* to determine how to handle the buffer.
*
src/openflow/model/openflow-switch-net-device.h
-40
View File
@@ -247,8 +247,6 @@ protected:
virtual void DoDispose (void);
/**
* \internal
*
* Called when a packet is received on one of the switch's ports.
*
* \param netdev The port the packet was received on.
@@ -261,8 +259,6 @@ protected:
void ReceiveFromDevice (Ptr<NetDevice> netdev, Ptr<const Packet> packet, uint16_t protocol, const Address& src, const Address& dst, PacketType packetType);
/**
* \internal
*
* Takes a packet and generates an OpenFlow buffer from it, loading the packet data as well as its headers.
*
* \param packet The packet.
@@ -276,8 +272,6 @@ protected:
private:
/**
* \internal
*
* Add a flow.
*
* \sa #ENOMEM, #ENOBUFS, #ESRCH
@@ -288,8 +282,6 @@ private:
int AddFlow (const ofp_flow_mod *ofm);
/**
* \internal
*
* Modify a flow.
*
* \param ofm The flow data to modify.
@@ -298,8 +290,6 @@ private:
int ModFlow (const ofp_flow_mod *ofm);
/**
* \internal
*
* Send packets out all the ports except the originating one
*
* \param packet_uid Packet UID; used to fetch the packet and its metadata.
@@ -310,8 +300,6 @@ private:
int OutputAll (uint32_t packet_uid, int in_port, bool flood);
/**
* \internal
*
* Sends a copy of the Packet over the provided output port
*
* \param packet_uid Packet UID; used to fetch the packet and its metadata.
@@ -319,8 +307,6 @@ private:
void OutputPacket (uint32_t packet_uid, int out_port);
/**
* \internal
*
* Seeks to send out a Packet over the provided output port. This is called generically
* when we may or may not know the specific port we're outputting on. There are many
* pre-set types of port options besides a Port that's hooked to our OpenFlowSwitchNetDevice.
@@ -334,8 +320,6 @@ private:
void OutputPort (uint32_t packet_uid, int in_port, int out_port, bool ignore_no_fwd);
/**
* \internal
*
* Sends a copy of the Packet to the controller. If the packet can be saved
* in an OpenFlow buffer, then only the first 'max_len' bytes of the packet
* are sent; otherwise, all of the packet is sent.
@@ -348,8 +332,6 @@ private:
void OutputControl (uint32_t packet_uid, int in_port, size_t max_len, int reason);
/**
* \internal
*
* If an error message happened during the controller's request, send it to the controller.
*
* \param type The type of error.
@@ -360,8 +342,6 @@ private:
void SendErrorMsg (uint16_t type, uint16_t code, const void *data, size_t len);
/**
* \internal
*
* Send a reply about this OpenFlow switch's features to the controller.
*
* List of capabilities and actions to support are found in the specification
@@ -385,8 +365,6 @@ private:
void SendFeaturesReply ();
/**
* \internal
*
* Send a reply to the controller that a specific flow has expired.
*
* \param flow The flow that expired.
@@ -395,8 +373,6 @@ private:
void SendFlowExpired (sw_flow *flow, enum ofp_flow_expired_reason reason);
/**
* \internal
*
* Send a reply about a Port's status to the controller.
*
* \param p The port to get status from.
@@ -405,15 +381,11 @@ private:
void SendPortStatus (ofi::Port p, uint8_t status);
/**
* \internal
*
* Send a reply about this OpenFlow switch's virtual port table features to the controller.
*/
void SendVPortTableFeatures ();
/**
* \internal
*
* Send a message to the controller. This method is the key
* to communicating with the controller, it does the actual
* sending. The other Send methods call this one when they
@@ -425,8 +397,6 @@ private:
int SendOpenflowBuffer (ofpbuf *buffer);
/**
* \internal
*
* Run the packet through the flow table. Looks up in the flow table for a match.
* If it doesn't match, it forwards the packet to the registered controller, if the flag is set.
*
@@ -437,8 +407,6 @@ private:
void RunThroughFlowTable (uint32_t packet_uid, int port, bool send_to_controller = true);
/**
* \internal
*
* Run the packet through the vport table. As with AddVPort,
* this doesn't have an understood use yet.
*
@@ -450,8 +418,6 @@ private:
int RunThroughVPortTable (uint32_t packet_uid, int port, uint32_t vport);
/**
* \internal
*
* Called by RunThroughFlowTable on a scheduled delay
* to account for the flow table lookup overhead.
*
@@ -464,8 +430,6 @@ private:
void FlowTableLookup (sw_flow_key key, ofpbuf* buffer, uint32_t packet_uid, int port, bool send_to_controller);
/**
* \internal
*
* Update the port status field of the switch port.
* A non-zero return value indicates some field has changed.
*
@@ -475,8 +439,6 @@ private:
int UpdatePortStatus (ofi::Port& p);
/**
* \internal
*
* Fill out a description of the switch port.
*
* \param p The port to get the description from.
@@ -485,8 +447,6 @@ private:
void FillPortDesc (ofi::Port p, ofp_phy_port *desc);
/**
* \internal
*
* Generates an OpenFlow reply message based on the type.
*
* \param openflow_len Length of the reply to make.
src/point-to-point/helper/point-to-point-helper.h
-1
View File
@@ -167,7 +167,6 @@ private:
/**
* \brief Enable ascii trace output on the indicated net device.
* \internal
*
* NetDevice-specific implementation mechanism for hooking the trace and
* writing to the trace file.
src/spectrum/test/spectrum-test.h
-6
View File
@@ -41,9 +41,6 @@
NS_TEST_ASSERT_MSG_SPECTRUM_MODEL_EQ_TOL_INTERNAL (actual, expected, tol, msg, __FILE__, __LINE__)
/**
* \internal
*/
#define NS_TEST_ASSERT_MSG_SPECTRUM_MODEL_EQ_TOL_INTERNAL(actual, expected, tol, msg, file, line) \
do \
{ \
@@ -105,9 +102,6 @@
NS_TEST_ASSERT_MSG_SPECTRUM_VALUE_EQ_TOL_INTERNAL (actual, expected, tol, msg, __FILE__, __LINE__)
/**
* \internal
*/
#define NS_TEST_ASSERT_MSG_SPECTRUM_VALUE_EQ_TOL_INTERNAL(actual, expected, tol, msg, file, line) \
do \
{ \
src/stats/model/boolean-probe.h
-2
View File
@@ -98,8 +98,6 @@ private:
*
* \param oldData previous value of the bool
* \param newData new value of the bool
*
* \internal
*/
void TraceSink (bool oldData, bool newData);
src/tap-bridge/model/tap-bridge.h
-58
View File
@@ -210,8 +210,6 @@ public:
protected:
/**
* \internal
*
* Call out to a separate process running as suid root in order to get our
* tap device created. We do this to avoid having the entire simulation
* running as root. If this method returns, we'll have a socket waiting
@@ -227,8 +225,6 @@ protected:
private:
/**
* \internal
*
* Call out to a separate process running as suid root in order to get our
* tap device created. We do this to avoid having the entire simulation
* running as root. If this method returns, we'll have a socket waiting
@@ -237,29 +233,21 @@ private:
void CreateTap (void);
/**
* \internal
*
* Spin up the device
*/
void StartTapDevice (void);
/**
* \internal
*
* Tear down the device
*/
void StopTapDevice (void);
/**
* \internal
*
* Callback to process packets that are read
*/
void ReadCallback (uint8_t *buf, ssize_t len);
/*
* \internal
*
* Forward a packet received from the tap device to the bridged ns-3
* device
*
@@ -270,8 +258,6 @@ private:
void ForwardToBridgedDevice (uint8_t *buf, ssize_t len);
/**
* \internal
*
* The host we are bridged to is in the evil real world. Do some sanity
* checking on a received packet to make sure it isn't too evil for our
* poor naive virginal simulator to handle.
@@ -294,8 +280,6 @@ private:
void NotifyLinkUp (void);
/**
* \internal
*
* Callback used to hook the standard packet receive callback of the TapBridge
* ns-3 net device. This is never called, and therefore no packets will ever
* be received forwarded up the IP stack on the ghost node through this device.
@@ -303,8 +287,6 @@ private:
NetDevice::ReceiveCallback m_rxCallback;
/**
* \internal
*
* Callback used to hook the promiscuous packet receive callback of the TapBridge
* ns-3 net device. This is never called, and therefore no packets will ever
* be received forwarded up the IP stack on the ghost node through this device.
@@ -316,70 +298,52 @@ private:
NetDevice::PromiscReceiveCallback m_promiscRxCallback;
/**
* \internal
*
* Pointer to the (ghost) Node to which we are connected.
*/
Ptr<Node> m_node;
/**
* \internal
*
* The ns-3 interface index of this TapBridge net device.
*/
uint32_t m_ifIndex;
/**
* \internal
*
* The common mtu to use for the net devices
*/
uint16_t m_mtu;
/**
* \internal
*
* The socket (actually interpreted as fd) to use to talk to the Tap device on
* the real internet host.
*/
int m_sock;
/**
* \internal
*
* The ID of the ns-3 event used to schedule the start up of the underlying
* host Tap device and ns-3 read thread.
*/
EventId m_startEvent;
/**
* \internal
*
* The ID of the ns-3 event used to schedule the tear down of the underlying
* host Tap device and ns-3 read thread.
*/
EventId m_stopEvent;
/**
* \internal
*
* Includes the ns-3 read thread used to do blocking reads on the fd
* corresponding to the host device.
*/
Ptr<TapBridgeFdReader> m_fdReader;
/**
* \internal
*
* The operating mode of the bridge. Tells basically who creates and
* configures the underlying network tap.
*/
Mode m_mode;
/**
* \internal
*
* The (unused) MAC address of the TapBridge net device. Since the TapBridge
* is implemented as a ns-3 net device, it is required to implement certain
* functionality. In this case, the TapBridge is automatically assigned a
@@ -388,43 +352,31 @@ private:
Mac48Address m_address;
/**
* \internal
*
* Time to start spinning up the device
*/
Time m_tStart;
/**
* \internal
*
* Time to start tearing down the device
*/
Time m_tStop;
/**
* \internal
*
* The name of the device to create on the host. If the device name is the
* empty string, we allow the host kernel to choose a name.
*/
std::string m_tapDeviceName;
/**
* \internal
*
* The IP address to use as the device default gateway on the host.
*/
Ipv4Address m_tapGateway;
/**
* \internal
*
* The IP address to use as the device IP on the host.
*/
Ipv4Address m_tapIp;
/**
* \internal
*
* The MAC address to use as the hardware address on the host; only used
* in UseLocal mode. This value comes from the MAC
* address assigned to the bridged ns-3 net device and matches the MAC
@@ -434,21 +386,15 @@ private:
Mac48Address m_tapMac;
/**
* \internal
*
* The network mask to assign to the device created on the host.
*/
Ipv4Mask m_tapNetmask;
/**
* \internal
*
* The ns-3 net device to which we are bridging.
*/
Ptr<NetDevice> m_bridgedDevice;
/**
* \internal
*
* Whether the MAC address of the underlying ns-3 device has already been
* rewritten is stored in this variable (for UseLocal/UseBridge mode only).
*/
@@ -467,8 +413,6 @@ private:
uint32_t m_nodeId;
/**
* \internal
*
* Flag indicating whether or not the link is up. In this case,
* whether or not ns-3 is connected to the underlying TAP device
* with a file descriptor.
@@ -476,8 +420,6 @@ private:
bool m_linkUp;
/**
* \internal
*
* Callbacks to fire if the link changes state (up or down).
*/
TracedCallback<> m_linkChangeCallbacks;
src/visualizer/model/visual-simulator-impl.h
-1
View File
@@ -36,7 +36,6 @@ namespace ns3 {
* \ingroup simulator
*
* \brief A replacement simulator that starts the visualizer
* \internal
*
* To use this class, run any ns-3 simulation with the command-line
* argument --SimulatorImplementationType=ns3::VisualSimulatorImpl.
src/wave/helper/wave-mac-helper.h
-2
View File
@@ -38,7 +38,6 @@ public:
NqosWaveMacHelper (void);
/**
* \internal
* Destroy a NqosWaveMacHelper.
*/
virtual ~NqosWaveMacHelper (void);
@@ -93,7 +92,6 @@ public:
QosWaveMacHelper (void);
/**
* \internal
* Destroy a QosWaveMacHelper
*/
virtual ~QosWaveMacHelper (void);
src/wifi/helper/athstats-helper.h
+1 -7
View File
@@ -193,14 +193,8 @@ public:
void Open (std::string const& name);
private:
/**
* @internal
*/
void WriteStats ();
/**
* @internal
*/
void WriteStats ();
void ResetCounters ();
uint32_t m_txCount;
src/wifi/helper/ht-wifi-mac-helper.h
-1
View File
@@ -43,7 +43,6 @@ public:
HtWifiMacHelper ();
/**
* \internal
* Destroy a HtWifiMacHelper
*/
virtual ~HtWifiMacHelper ();
src/wifi/helper/nqos-wifi-mac-helper.h
-2
View File
@@ -40,7 +40,6 @@ public:
NqosWifiMacHelper ();
/**
* \internal
* Destroy a NqosWifiMacHelper.
*/
@@ -85,7 +84,6 @@ protected:
ObjectFactory m_mac;
private:
/**
* \internal
* \returns a newly-created MAC object.
*
* This method implements the pure virtual method defined in \ref ns3::WifiMacHelper.
src/wifi/helper/qos-wifi-mac-helper.h
-2
View File
@@ -43,7 +43,6 @@ public:
QosWifiMacHelper ();
/**
* \internal
* Destroy a QosWifiMacHelper
*/
virtual ~QosWifiMacHelper ();
@@ -135,7 +134,6 @@ protected:
ObjectFactory m_mac;
private:
/**
* \internal
* \returns a newly-created MAC object.
*
* This method implements the pure virtual method defined in \ref ns3::WifiMacHelper.
src/wifi/helper/yans-wifi-helper.h
-1
View File
@@ -271,7 +271,6 @@ private:
/**
* \brief Enable ascii trace output on the indicated net device.
* \internal
*
* NetDevice-specific implementation mechanism for hooking the trace and
* writing to the trace file.
src/wifi/test/wifi-test.cc
-2
View File
@@ -214,7 +214,6 @@ public:
//-----------------------------------------------------------------------------
/**
* \internal
* See \bugid{991}
*/
class InterferenceHelperSequenceTest : public TestCase
@@ -352,7 +351,6 @@ InterferenceHelperSequenceTest::DoRun (void)
* since that would require two successions of 0 backoff (one that generates the virtual collision and
* one after the virtual collision).
*
* \internal
* See \bugid{555}
*/
src/wimax/helper/wimax-helper.h
-2
View File
@@ -277,7 +277,6 @@ private:
static void AsciiTxEvent (Ptr<OutputStreamWrapper> stream, std::string path, Ptr<const Packet> packet, const Mac48Address &dest);
/**
* \brief Enable pcap output on the indicated net device.
* \internal
*
* NetDevice-specific implementation mechanism for hooking the trace and
* writing to the trace file.
@@ -291,7 +290,6 @@ private:
/**
* \brief Enable ascii trace output on the indicated net device.
* \internal
*
* NetDevice-specific implementation mechanism for hooking the trace and
* writing to the trace file.