From 247a597f43be35dc3c7740d85db8ba5e759f0380 Mon Sep 17 00:00:00 2001 From: Tommaso Pecorella Date: Fri, 7 Jan 2022 12:13:17 -0600 Subject: [PATCH] doxygen: fix warnings in various modules --- src/internet/model/tcp-bbr.h | 8 +++ src/internet/model/tcp-cubic.h | 2 +- src/internet/model/tcp-linux-reno.h | 8 +++ src/internet/model/tcp-lp.h | 5 ++ src/lr-wpan/model/lr-wpan-lqi-tag.h | 9 +++ src/lte/model/epc-enb-application.h | 4 +- src/lte/model/epc-s1ap-sap.h | 2 +- src/lte/model/epc-tft.h | 5 +- src/lte/model/epc-x2.h | 8 +-- src/lte/model/lte-asn1-header.h | 7 -- src/lte/model/lte-enb-phy-sap.h | 1 - src/lte/model/lte-enb-phy.h | 3 +- src/lte/model/lte-enb-rrc.h | 2 - src/lte/model/lte-rlc-am.h | 2 +- src/lte/model/lte-spectrum-value-helper.cc | 10 +++ src/lte/model/lte-ue-phy-sap.h | 1 - src/netanim/model/animation-interface.h | 23 ------ src/netanim/test/netanim-test.cc | 4 -- src/stats/examples/double-probe-example.cc | 9 ++- src/stats/examples/file-aggregator-example.cc | 34 +++------ src/stats/examples/file-helper-example.cc | 15 ++-- .../examples/gnuplot-aggregator-example.cc | 10 +-- src/stats/examples/gnuplot-example.cc | 30 +++----- src/stats/examples/gnuplot-helper-example.cc | 15 ++-- src/stats/examples/time-probe-example.cc | 18 ++--- src/stats/model/average.h | 49 ++++++++++--- src/stats/model/data-collection-object.h | 15 +++- src/stats/model/gnuplot.cc | 2 + src/stats/model/gnuplot.h | 2 +- src/stats/model/sqlite-data-output.h | 4 +- src/stats/model/sqlite-output.cc | 12 ++++ src/stats/model/sqlite-output.h | 9 +++ src/stats/test/average-test-suite.cc | 37 ++++++---- .../test/basic-data-calculators-test-suite.cc | 39 ++++++---- src/stats/test/double-probe-test-suite.cc | 51 ++++++++++--- .../examples/virtual-net-device.cc | 71 ++++++++++++++++--- .../model/virtual-net-device.h | 37 +++++----- src/wimax/model/bs-link-manager.h | 2 + src/wimax/model/bs-net-device.h | 2 + src/wimax/model/bs-scheduler-simple.h | 2 + src/wimax/model/bs-scheduler.h | 2 + src/wimax/model/bs-uplink-scheduler-simple.h | 2 + src/wimax/model/burst-profile-manager.h | 2 + src/wimax/model/ipcs-classifier.h | 2 + src/wimax/model/wimax-phy.h | 2 + utils/check-style.py | 3 - 46 files changed, 377 insertions(+), 205 deletions(-) diff --git a/src/internet/model/tcp-bbr.h b/src/internet/model/tcp-bbr.h index 827fabc9b..b67155b35 100644 --- a/src/internet/model/tcp-bbr.h +++ b/src/internet/model/tcp-bbr.h @@ -33,6 +33,14 @@ class TcpBbrCheckGainValuesTest; namespace ns3 { +/** + * \ingroup congestionOps + * + * \brief BBR congestion control algorithm + * + * This class implement the BBR (Bottleneck Bandwidth and Round-trip propagation time) + * congestion control type. + */ class TcpBbr : public TcpCongestionOps { public: diff --git a/src/internet/model/tcp-cubic.h b/src/internet/model/tcp-cubic.h index 14c10b390..208ef69f8 100644 --- a/src/internet/model/tcp-cubic.h +++ b/src/internet/model/tcp-cubic.h @@ -43,7 +43,7 @@ namespace ns3 { * Following the Linux implementation, we included the Hybrid Slow Start, * that effectively prevents the overshooting of slow start * while maintaining a full utilization of the network. This new type of slow - * start can be disabled through the \Attribute{HyStart} attribute. + * start can be disabled through the HyStart attribute. * * CUBIC TCP is implemented and used by default in Linux kernels 2.6.19 * and above; this version follows the implementation in Linux 3.14, which diff --git a/src/internet/model/tcp-linux-reno.h b/src/internet/model/tcp-linux-reno.h index 279b3461c..d933cc2cf 100644 --- a/src/internet/model/tcp-linux-reno.h +++ b/src/internet/model/tcp-linux-reno.h @@ -28,6 +28,14 @@ namespace ns3 { +/** + * \ingroup congestionOps + * + * \brief Reno congestion control algorithm + * + * This class implement the Reno congestion control type + * and it mimics the one implemented in the Linux kernel. + */ class TcpLinuxReno : public TcpCongestionOps { public: diff --git a/src/internet/model/tcp-lp.h b/src/internet/model/tcp-lp.h index d659ba702..718e4a68e 100644 --- a/src/internet/model/tcp-lp.h +++ b/src/internet/model/tcp-lp.h @@ -32,6 +32,11 @@ namespace ns3 { class TcpSocketState; +/** + * \ingroup congestionOps + * + * \brief TCP-LP (Low Priority) congestion control algorithm + */ class TcpLp : public TcpNewReno { public: diff --git a/src/lr-wpan/model/lr-wpan-lqi-tag.h b/src/lr-wpan/model/lr-wpan-lqi-tag.h index c6ddfbb29..d62b44c5f 100644 --- a/src/lr-wpan/model/lr-wpan-lqi-tag.h +++ b/src/lr-wpan/model/lr-wpan-lqi-tag.h @@ -25,6 +25,15 @@ namespace ns3 { +/** + * \ingroup lr-wpan + * Represent the LQI (Link Quality Estination). + * + * The LQI Tag is added to each received packet, and can be + * used by upper layers to estimate the channel conditions. + * + * The LQI is the total packet success rate scaled to 0-255. + */ class LrWpanLqiTag : public Tag { public: diff --git a/src/lte/model/epc-enb-application.h b/src/lte/model/epc-enb-application.h index ba69bc533..2acc5d708 100644 --- a/src/lte/model/epc-enb-application.h +++ b/src/lte/model/epc-enb-application.h @@ -81,8 +81,8 @@ public: * Add a S1-U interface to the eNB * * \param s1uSocket the socket to be used to send/receive packets to/from the S1-U interface connected with the SGW - * \param enbS1uAddress the IPv4 address of the S1-U interface of this eNB - * \param sgwS1uAddress the IPv4 address at which this eNB will be able to reach its SGW for S1-U communications + * \param enbAddress the IPv4 address of the S1-U interface of this eNB + * \param sgwAddress the IPv4 address at which this eNB will be able to reach its SGW for S1-U communications */ void AddS1Interface (Ptr s1uSocket, Ipv4Address enbAddress, Ipv4Address sgwAddress); diff --git a/src/lte/model/epc-s1ap-sap.h b/src/lte/model/epc-s1ap-sap.h index 632fabbbf..787bf66fa 100644 --- a/src/lte/model/epc-s1ap-sap.h +++ b/src/lte/model/epc-s1ap-sap.h @@ -79,7 +79,7 @@ public: * \brief As per 3GPP TS version 9.8.0 section 8.2.3.2.2, the eNB initiates the procedure by sending an E-RAB RELEASE INDICATION message towards MME * \param mmeUeS1Id in practice, we use the IMSI * \param enbUeS1Id in practice, we use the RNTI - * \param erabToBeReleaseIndication, List of bearers to be deactivated + * \param erabToBeReleaseIndication List of bearers to be deactivated * */ virtual void ErabReleaseIndication (uint64_t mmeUeS1Id, uint16_t enbUeS1Id, std::list erabToBeReleaseIndication ) = 0; diff --git a/src/lte/model/epc-tft.h b/src/lte/model/epc-tft.h index d8f0c9017..db0dd12b8 100644 --- a/src/lte/model/epc-tft.h +++ b/src/lte/model/epc-tft.h @@ -194,7 +194,10 @@ public: uint16_t localPort, uint8_t typeOfService); - + /** + * Get the packet filters + * \return a containter of packet filters + */ std::list GetPacketFilters () const; private: diff --git a/src/lte/model/epc-x2.h b/src/lte/model/epc-x2.h index 7a1919919..82f35994b 100644 --- a/src/lte/model/epc-x2.h +++ b/src/lte/model/epc-x2.h @@ -51,10 +51,10 @@ public: /** * Assignment operator - * + * \param value value to assign * \returns X2IfaceInfo& */ - X2IfaceInfo& operator= (const X2IfaceInfo &); + X2IfaceInfo& operator= (const X2IfaceInfo &value); public: Ipv4Address m_remoteIpAddr; ///< remote IP address @@ -80,10 +80,10 @@ public: /** * Assignment operator - * + * \param value value to assign * \returns X2CellInfo& */ - X2CellInfo& operator= (const X2CellInfo &); + X2CellInfo& operator= (const X2CellInfo &value); public: uint16_t m_localCellId; ///< local cell ID diff --git a/src/lte/model/lte-asn1-header.h b/src/lte/model/lte-asn1-header.h index 625757579..06405f0c6 100644 --- a/src/lte/model/lte-asn1-header.h +++ b/src/lte/model/lte-asn1-header.h @@ -329,13 +329,6 @@ protected: * \returns the modified buffer iterator */ template - /** - * Deserialize a sequence - * \param optionalOrDefaultMask buffer to store the result - * \param isExtensionMarkerPresent true if Extension Marker is present - * \param bIterator buffer iterator - * \returns the modified buffer iterator - */ Buffer::Iterator DeserializeSequence (std::bitset *optionalOrDefaultMask, bool isExtensionMarkerPresent, Buffer::Iterator bIterator); diff --git a/src/lte/model/lte-enb-phy-sap.h b/src/lte/model/lte-enb-phy-sap.h index ce41f939e..3c77425db 100644 --- a/src/lte/model/lte-enb-phy-sap.h +++ b/src/lte/model/lte-enb-phy-sap.h @@ -45,7 +45,6 @@ public: /** * \brief Send the MAC PDU to the channel * \param p the MAC PDU to send - * \return true if */ virtual void SendMacPdu (Ptr p) = 0; diff --git a/src/lte/model/lte-enb-phy.h b/src/lte/model/lte-enb-phy.h index e1fe40369..bbb23a650 100644 --- a/src/lte/model/lte-enb-phy.h +++ b/src/lte/model/lte-enb-phy.h @@ -274,8 +274,9 @@ public: /** * \brief PhySpectrum received a new list of LteControlMessage + * \param msgList List of control messages */ - virtual void ReceiveLteControlMessageList (std::list >); + virtual void ReceiveLteControlMessageList (std::list > msgList); // inherited from LtePhy virtual void GenerateCtrlCqiReport (const SpectrumValue& sinr); diff --git a/src/lte/model/lte-enb-rrc.h b/src/lte/model/lte-enb-rrc.h index 6f7514c3d..e7940dde6 100644 --- a/src/lte/model/lte-enb-rrc.h +++ b/src/lte/model/lte-enb-rrc.h @@ -108,8 +108,6 @@ public: * \param rnti RNTI of the UE * \param s initial state of the UeManager * \param componentCarrierId primary component carrier ID - * - * \return */ UeManager (Ptr rrc, uint16_t rnti, State s, uint8_t componentCarrierId); diff --git a/src/lte/model/lte-rlc-am.h b/src/lte/model/lte-rlc-am.h index 8fa7804a2..e3a97c72c 100644 --- a/src/lte/model/lte-rlc-am.h +++ b/src/lte/model/lte-rlc-am.h @@ -135,7 +135,7 @@ private: { Ptr m_pdu; ///< PDU uint16_t m_retxCount; ///< retransmit count - Time m_waitingSince; ///!< Layer arrival time + Time m_waitingSince; ///< Layer arrival time }; std::vector m_txedBuffer; ///< Buffer for transmitted and retransmitted PDUs diff --git a/src/lte/model/lte-spectrum-value-helper.cc b/src/lte/model/lte-spectrum-value-helper.cc index 1f49b9167..36a3a475f 100644 --- a/src/lte/model/lte-spectrum-value-helper.cc +++ b/src/lte/model/lte-spectrum-value-helper.cc @@ -30,6 +30,16 @@ // just needed to log a std::vector properly... namespace std { +/** + * \brief Stream insertion operator. + * + * \note This function scope is stricly local, and can not be + * used in other source files. + * + * \param [in] os The reference to the output stream. + * \param [in] v The std::vector. + * \returns The reference to the output stream. + */ ostream& operator << (ostream& os, const vector& v) { diff --git a/src/lte/model/lte-ue-phy-sap.h b/src/lte/model/lte-ue-phy-sap.h index aa19f40fa..ed50e2bcc 100644 --- a/src/lte/model/lte-ue-phy-sap.h +++ b/src/lte/model/lte-ue-phy-sap.h @@ -44,7 +44,6 @@ public: * \brief Send the MAC PDU to the channel * * \param p the MAC PDU to send - * \return true if */ virtual void SendMacPdu (Ptr p) = 0; diff --git a/src/netanim/model/animation-interface.h b/src/netanim/model/animation-interface.h index 8fd72e7df..9fc25ac87 100644 --- a/src/netanim/model/animation-interface.h +++ b/src/netanim/model/animation-interface.h @@ -111,7 +111,6 @@ public: * \param stopTime Stop Time for capturing values * \param pollInterval The periodic interval at which the counters are written to the trace file * Default: 1s - * \returns none */ void EnableIpv4L3ProtocolCounters (Time startTime, Time stopTime, Time pollInterval = Seconds (1)); @@ -122,7 +121,6 @@ public: * \param stopTime Stop Time for capturing values * \param pollInterval The periodic interval at which the counters are written to the trace file * Default: 1s - * \returns none */ void EnableQueueCounters (Time startTime, Time stopTime, Time pollInterval = Seconds (1)); @@ -133,7 +131,6 @@ public: * \param stopTime Stop Time for capturing values * \param pollInterval The periodic interval at which the counters are written to the trace file * Default: 1s - * \returns none */ void EnableWifiMacCounters (Time startTime, Time stopTime, Time pollInterval = Seconds (1)); @@ -144,7 +141,6 @@ public: * \param stopTime Stop Time for capturing values * \param pollInterval The periodic interval at which the counters are written to the trace file * Default: 1s - * \returns none */ void EnableWifiPhyCounters (Time startTime, Time stopTime, Time pollInterval = Seconds (1)); @@ -188,7 +184,6 @@ public: * * \param t The time at which AnimationInterface should begin capture of traffic info * - * \returns none */ void SetStartTime (Time t); @@ -197,7 +192,6 @@ public: * * \param t The time at which AnimationInterface should stop capture of traffic info * - * \returns none */ void SetStopTime (Time t); @@ -208,7 +202,6 @@ public: filenames : filename, filename-1, filename-2..., filename-N where each file contains packet info for 'maxPktsPerFile' number of packets * - * \returns none */ void SetMaxPktsPerTraceFile (uint64_t maxPktsPerFile); @@ -219,7 +212,6 @@ public: * \param t Time interval between fetching mobility/position information * Default: 0.25s * - * \returns none */ void SetMobilityPollInterval (Time t); @@ -228,14 +220,12 @@ public: * * \param cb Address of callback function * - * \returns none */ void SetAnimWriteCallback (AnimWriteCallback cb); /** * \brief Reset the write callback function * - * \returns none */ void ResetAnimWriteCallback (); @@ -246,7 +236,6 @@ public: * \param y Y co-ordinate of the node * \param z Z co-ordinate of the node * - * \returns none */ static void SetConstantPosition (Ptr n, double x, double y, double z = 0); @@ -255,7 +244,6 @@ public: * \param n Ptr to the node * \param descr A string to briefly describe the node * - * \returns none */ void UpdateNodeDescription (Ptr n, std::string descr); @@ -264,7 +252,6 @@ public: * \param nodeId Id of the node * \param descr A string to briefly describe the node * - * \returns none */ void UpdateNodeDescription (uint32_t nodeId, std::string descr); @@ -273,7 +260,6 @@ public: * \param nodeId Id of the node * \param resourceId Id of the image resource that was previously added * - * \returns none */ void UpdateNodeImage (uint32_t nodeId, uint32_t resourceId); @@ -283,7 +269,6 @@ public: * \param width Width of the node * \param height Height of the node * - * \returns none */ void UpdateNodeSize (uint32_t nodeId, double width, double height); @@ -294,7 +279,6 @@ public: * \param g Green component value (0-255) * \param b Blue component value (0-255) * - * \returns none */ void UpdateNodeColor (Ptr n, uint8_t r, uint8_t g, uint8_t b); @@ -305,7 +289,6 @@ public: * \param g Green component value (0-255) * \param b Blue component value (0-255) * - * \returns none */ void UpdateNodeColor (uint32_t nodeId, uint8_t r, uint8_t g, uint8_t b); @@ -315,7 +298,6 @@ public: * \param nodeId Node Id of the node * \param counter Current value of the counter * - * \returns none */ void UpdateNodeCounter (uint32_t nodeCounterId, uint32_t nodeId, double counter); @@ -329,7 +311,6 @@ public: * \param opacity Opacity of the background: A value between 0.0 and 1.0. 0.0 is transparent, * 1.0 is opaque * - * \returns none */ void SetBackgroundImage (std::string fileName, double x, double y, double scaleX, double scaleY, double opacity); @@ -339,7 +320,6 @@ public: * \param toNode Node Id of the "to Node" of the p2p link * \param linkDescription Description of the link such as link bandwidth * - * \returns none */ void UpdateLinkDescription (uint32_t fromNode, uint32_t toNode, std::string linkDescription); @@ -350,7 +330,6 @@ public: * \param toNode Ptr to the "to Node" of the p2p link * \param linkDescription Description of the link such as link bandwidth * - * \returns none */ void UpdateLinkDescription (Ptr fromNode, Ptr toNode, std::string linkDescription); @@ -374,7 +353,6 @@ public: /** * \brief Do not trace packets. This helps reduce the trace file size if AnimationInterface is solely * used for tracking mobility, routing paths and counters - * \returns none */ void SkipPacketTracing (); @@ -384,7 +362,6 @@ public: * \param enable if true enables writing the packet metadata to the XML trace file * if false disables writing the packet metadata * - * \returns none */ void EnablePacketMetadata (bool enable = true); diff --git a/src/netanim/test/netanim-test.cc b/src/netanim/test/netanim-test.cc index b51828bb6..546cf7eee 100644 --- a/src/netanim/test/netanim-test.cc +++ b/src/netanim/test/netanim-test.cc @@ -57,10 +57,6 @@ public: */ virtual ~AbstractAnimationInterfaceTestCase (); - /** - * \brief Run unit tests for this class. - * \return false if all tests have passed, false otherwise - */ virtual void DoRun (void); diff --git a/src/stats/examples/double-probe-example.cc b/src/stats/examples/double-probe-example.cc index 5b78bb094..e9d4a05a6 100644 --- a/src/stats/examples/double-probe-example.cc +++ b/src/stats/examples/double-probe-example.cc @@ -31,7 +31,7 @@ using namespace ns3; NS_LOG_COMPONENT_DEFINE ("DoubleProbeExample"); -/* +/** * This is our test object, an object that increments counters at * various times and emits one of them as a trace source. */ @@ -46,11 +46,14 @@ public: Emitter (); private: void DoInitialize (void); + + /// Generate data - actually this function is not traced. void Emit (void); + /// Counts how many times this function is called. void Count (void); - TracedValue m_counter; // normally this would be integer type - Ptr m_var; + TracedValue m_counter; //!< Sample counter, normally this would be integer type + Ptr m_var; //!< Random number generator }; diff --git a/src/stats/examples/file-aggregator-example.cc b/src/stats/examples/file-aggregator-example.cc index 62a224d33..aa7c8d6b0 100644 --- a/src/stats/examples/file-aggregator-example.cc +++ b/src/stats/examples/file-aggregator-example.cc @@ -25,14 +25,10 @@ using namespace ns3; namespace { -//=========================================================================== -// Function: CreateCommaSeparatedFile -// -// -// This function creates a file with 2 columns of values and separated -// by commas. -//=========================================================================== - +/** + * This function creates a file with 2 columns of values and separated + * by commas. + */ void CreateCommaSeparatedFile () { using namespace std; @@ -69,14 +65,10 @@ void CreateCommaSeparatedFile () } -//=========================================================================== -// Function: CreateSpaceSeparatedFile -// -// -// This function creates a file with 2 columns of values and separated -// by spaces. -//=========================================================================== - +/** + * This function creates a file with 2 columns of values and separated + * by commas. + */ void CreateSpaceSeparatedFile () { using namespace std; @@ -114,13 +106,9 @@ void CreateSpaceSeparatedFile () } -//=========================================================================== -// Function: CreateFormattedFile -// -// -// This function creates a file with formatted values. -//=========================================================================== - +/** + * This function creates a file with formatted values. + */ void CreateFormattedFile () { using namespace std; diff --git a/src/stats/examples/file-helper-example.cc b/src/stats/examples/file-helper-example.cc index 4c2bfe883..8b6caa414 100644 --- a/src/stats/examples/file-helper-example.cc +++ b/src/stats/examples/file-helper-example.cc @@ -34,11 +34,11 @@ using namespace ns3; NS_LOG_COMPONENT_DEFINE ("FileHelperExample"); -// -// This is our test object, an object that increments a counter according -// to a Poisson process, and exports the (integer-valued) count as a -// trace source. -// +/** + * This is our test object, an object that increments a counter according + * to a Poisson process, and exports the (integer-valued) count as a + * trace source. + */ class Emitter : public Object { public: @@ -50,10 +50,11 @@ public: Emitter (); private: void DoInitialize (void); + /// Counts how many time this function is called. void Count (void); - TracedValue m_counter; - Ptr m_var; + TracedValue m_counter; //!< Simple counter + Ptr m_var; //!< Random number generator. }; diff --git a/src/stats/examples/gnuplot-aggregator-example.cc b/src/stats/examples/gnuplot-aggregator-example.cc index 56cbe2377..91debf228 100644 --- a/src/stats/examples/gnuplot-aggregator-example.cc +++ b/src/stats/examples/gnuplot-aggregator-example.cc @@ -25,13 +25,9 @@ using namespace ns3; namespace { -//=========================================================================== -// Function: Create2dPlot -// -// -// This function creates a 2-Dimensional plot. -//=========================================================================== - +/** + * This function creates a 2-Dimensional plot. + */ void Create2dPlot () { using namespace std; diff --git a/src/stats/examples/gnuplot-example.cc b/src/stats/examples/gnuplot-example.cc index 5a2c7bafd..fc1633f9f 100644 --- a/src/stats/examples/gnuplot-example.cc +++ b/src/stats/examples/gnuplot-example.cc @@ -26,13 +26,9 @@ using namespace ns3; namespace { -//=========================================================================== -// Function: Create2DPlotFile -// -// -// This function creates a 2-D plot file. -//=========================================================================== - +/** + * This function creates a 2-D plot file. + */ void Create2DPlotFile () { std::string fileNameWithNoExtension = "plot-2d"; @@ -92,13 +88,9 @@ void Create2DPlotFile () } -//=========================================================================== -// Function: Create2DPlotWithErrorBarsFile -// -// -// This function creates a 2-D plot with error bars file. -//=========================================================================== - +/** + * This function creates a 2-D plot with error bars file. + */ void Create2DPlotWithErrorBarsFile () { std::string fileNameWithNoExtension = "plot-2d-with-error-bars"; @@ -170,13 +162,9 @@ void Create2DPlotWithErrorBarsFile () } -//=========================================================================== -// Function: Create3DPlotFile -// -// -// This function creates a 3-D plot file. -//=========================================================================== - +/** + * This function creates a 3-D plot file. + */ void Create3DPlotFile () { std::string fileNameWithNoExtension = "plot-3d"; diff --git a/src/stats/examples/gnuplot-helper-example.cc b/src/stats/examples/gnuplot-helper-example.cc index fb0486bc0..1d1e98066 100644 --- a/src/stats/examples/gnuplot-helper-example.cc +++ b/src/stats/examples/gnuplot-helper-example.cc @@ -34,11 +34,11 @@ using namespace ns3; NS_LOG_COMPONENT_DEFINE ("GnuplotHelperExample"); -// -// This is our test object, an object that increments a counter according -// to a Poisson process, and exports the (integer-valued) count as a -// trace source. -// +/** + * This is our test object, an object that increments a counter according + * to a Poisson process, and exports the (integer-valued) count as a + * trace source. + */ class Emitter : public Object { public: @@ -50,10 +50,11 @@ public: Emitter (); private: void DoInitialize (void); + /// Counts how many time this function is called. void Count (void); - TracedValue m_counter; - Ptr m_var; + TracedValue m_counter; //!< Simple counter + Ptr m_var; //!< Random number generator. }; NS_OBJECT_ENSURE_REGISTERED (Emitter); diff --git a/src/stats/examples/time-probe-example.cc b/src/stats/examples/time-probe-example.cc index 0e6f07fec..9d4f62920 100644 --- a/src/stats/examples/time-probe-example.cc +++ b/src/stats/examples/time-probe-example.cc @@ -45,11 +45,11 @@ using namespace ns3; NS_LOG_COMPONENT_DEFINE ("TimeProbeExample"); -// -// This is our test object, an object that emits values according to -// a Poisson arrival process. It emits a traced Time value as a -// trace source; this takes the value of interarrival time -// +/** + * This is our test object, an object that emits values according to + * a Poisson arrival process. It emits a traced Time value as a + * trace source; this takes the value of interarrival time + */ class Emitter : public Object { public: @@ -61,12 +61,12 @@ public: Emitter (); private: void DoInitialize (void); -// void Emit (void); + /// Generate data. void Emit (void); - TracedValue