--- a/src/csma-layout/model/csma-star-helper.h Wed May 18 20:01:44 2011 -0400
+++ b/src/csma-layout/model/csma-star-helper.h Wed May 18 17:24:04 2011 -0700
@@ -29,12 +29,12 @@
namespace ns3 {
/**
- * \defgroup csmastarhelper CSMA Star Helper
+ * \defgroup csmalayout CSMA Layout Helpers
*
*/
/**
- * \ingroup csmastarhelper
+ * \ingroup csmalayout
*
* \brief A helper to make it easier to create a star topology
* with Csma links
--- a/src/mpi/model/distributed-simulator-impl.h Wed May 18 20:01:44 2011 -0400
+++ b/src/mpi/model/distributed-simulator-impl.h Wed May 18 17:24:04 2011 -0700
@@ -29,6 +29,8 @@
namespace ns3 {
/**
+ * \ingroup mpi
+ *
* \brief Structure used for all-reduce LBTS computation
*/
class LbtsMessage
@@ -82,6 +84,8 @@
};
/**
+ * \ingroup mpi
+ *
* \brief distributed simulator implementation using lookahead
*/
class DistributedSimulatorImpl : public SimulatorImpl
--- a/src/mpi/model/mpi-interface.h Wed May 18 20:01:44 2011 -0400
+++ b/src/mpi/model/mpi-interface.h Wed May 18 17:24:04 2011 -0700
@@ -34,12 +34,19 @@
namespace ns3 {
/**
+ * \defgroup mpi MPI Distributed Simulation
+ *
+ */
+
+/**
* maximum MPI message size for easy
* buffer creation
*/
const uint32_t MAX_MPI_MSG_SIZE = 2000;
/**
+ * \ingroup mpi
+ *
* Define a class for tracking the non-block sends
*/
class SentBuffer
@@ -69,6 +76,8 @@
class Packet;
/**
+ * \ingroup mpi
+ *
* Interface between ns-3 and MPI
*/
class MpiInterface
--- a/src/mpi/model/mpi-receiver.h Wed May 18 20:01:44 2011 -0400
+++ b/src/mpi/model/mpi-receiver.h Wed May 18 17:24:04 2011 -0700
@@ -27,6 +27,8 @@
namespace ns3 {
/**
+ * \ingroup mpi
+ *
* Class to aggregate to a NetDevice if it supports MPI capability
*
* MpiInterface::ReceiveMessages () needs to send packets to a NetDevice
--- a/src/netanim/model/animation-interface.h Wed May 18 20:01:44 2011 -0400
+++ b/src/netanim/model/animation-interface.h Wed May 18 17:24:04 2011 -0700
@@ -31,9 +31,17 @@
namespace ns3 {
+
+/**
+ * \defgroup netanim Animation
+ *
+ */
+
class NetModel;
/**
+ * \ingroup netanim
+ *
* \brief Interface to network animator
*
* Provides functions that facilitate communications with an
--- a/src/netanim/model/canvas-location.h Wed May 18 20:01:44 2011 -0400
+++ b/src/netanim/model/canvas-location.h Wed May 18 17:24:04 2011 -0700
@@ -26,7 +26,10 @@
namespace ns3 {
+
/**
+ * \ingroup netanim
+ *
* \brief Keep track of the current location of an object
*
* This can be used anytime a logical node location is needed
--- a/src/point-to-point-layout/model/point-to-point-dumbbell.h Wed May 18 20:01:44 2011 -0400
+++ b/src/point-to-point-layout/model/point-to-point-dumbbell.h Wed May 18 17:24:04 2011 -0700
@@ -31,6 +31,8 @@
namespace ns3 {
/**
+ * \ingroup pointtopointlayout
+ *
* \brief A helper to make it easier to create a dumbbell topology
* with p2p links
*/
--- a/src/point-to-point-layout/model/point-to-point-grid.h Wed May 18 20:01:44 2011 -0400
+++ b/src/point-to-point-layout/model/point-to-point-grid.h Wed May 18 17:24:04 2011 -0700
@@ -30,6 +30,8 @@
namespace ns3 {
/**
+ * \ingroup pointtopointlayout
+ *
* \brief A helper to make it easier to create a grid topology
* with p2p links
*/
--- a/src/point-to-point-layout/model/point-to-point-star.h Wed May 18 20:01:44 2011 -0400
+++ b/src/point-to-point-layout/model/point-to-point-star.h Wed May 18 17:24:04 2011 -0700
@@ -29,6 +29,13 @@
namespace ns3 {
/**
+ * \defgroup pointtopointlayout Point-to-Point Layout Helpers
+ *
+ */
+
+/**
+ * \ingroup pointtopointlayout
+ *
* \brief A helper to make it easier to create a star topology
* with PointToPoint links
*/
--- a/src/propagation/model/cost231-propagation-loss-model.h Wed May 18 20:01:44 2011 -0400
+++ b/src/propagation/model/cost231-propagation-loss-model.h Wed May 18 17:24:04 2011 -0700
@@ -27,8 +27,11 @@
namespace ns3 {
-/*
+/**
+ * \ingroup propagation
+ *
* \brief The COST-Hata-Model is the most often cited of the COST 231 models.
+ *
* Also called the Hata Model PCS Extension, it is a radio propagation model
* that extends the Hata Model (which in turn is based on the Okumura Model)
* to cover a more elaborated range of frequencies. COST (COperation
--- a/src/propagation/model/jakes-propagation-loss-model.h Wed May 18 20:01:44 2011 -0400
+++ b/src/propagation/model/jakes-propagation-loss-model.h Wed May 18 17:24:04 2011 -0700
@@ -27,6 +27,8 @@
/**
+ * \ingroup propagation
+ *
* \brief a Jakes propagation loss model
*
* The Jakes propagation loss model implemented here is
--- a/src/propagation/model/propagation-delay-model.h Wed May 18 20:01:44 2011 -0400
+++ b/src/propagation/model/propagation-delay-model.h Wed May 18 17:24:04 2011 -0700
@@ -30,6 +30,8 @@
class MobilityModel;
/**
+ * \ingroup propagation
+ *
* \brief calculate a propagation delay.
*/
class PropagationDelayModel : public Object
@@ -49,6 +51,8 @@
};
/**
+ * \ingroup propagation
+ *
* \brief the propagation delay is random
*/
class RandomPropagationDelayModel : public PropagationDelayModel
@@ -67,6 +71,8 @@
};
/**
+ * \ingroup propagation
+ *
* \brief the propagation speed is constant
*/
class ConstantSpeedPropagationDelayModel : public PropagationDelayModel
--- a/src/propagation/model/propagation-loss-model.h Wed May 18 20:01:44 2011 -0400
+++ b/src/propagation/model/propagation-loss-model.h Wed May 18 17:24:04 2011 -0700
@@ -31,9 +31,16 @@
namespace ns3 {
+/**
+ * \defgroup propagation Propagation Models
+ *
+ */
+
class MobilityModel;
/**
+ * \ingroup propagation
+ *
* \brief Modelize the propagation loss through a transmission medium
*
* Calculate the receive power (dbm) from a transmit power (dbm)
@@ -77,6 +84,8 @@
};
/**
+ * \ingroup propagation
+ *
* \brief The propagation loss follows a random distribution.
*/
class RandomPropagationLossModel : public PropagationLossModel
@@ -97,6 +106,8 @@
};
/**
+ * \ingroup propagation
+ *
* \brief a Friis propagation loss model
*
* The Friis propagation loss model was first described in
@@ -193,7 +204,8 @@
double m_minDistance;
};
-/*
+/**
+ * \ingroup propagation
*
* \brief a Two-Ray Ground propagation loss model ported from NS2
*
@@ -215,7 +227,6 @@
*
* \f$ dCross = \frac{(4 * pi * Ht * Hr)}{lambda} \f$
*/
-
class TwoRayGroundPropagationLossModel : public PropagationLossModel
{
public:
@@ -285,6 +296,8 @@
};
/**
+ * \ingroup propagation
+ *
* \brief a log distance propagation model.
*
* This model calculates the reception power with a so-called
@@ -334,6 +347,8 @@
};
/**
+ * \ingroup propagation
+ *
* \brief A log distance path loss propagation model with three distance
* fields. This model is the same as ns3::LogDistancePropagationLossModel
* except that it has three distance fields: near, middle and far with
@@ -371,7 +386,6 @@
* reference distance defaults to 1m and reference loss defaults to
* ns3::FriisPropagationLossModel with 5.15 GHz and is thus \f$ L_0 \f$ = 46.67 dB.
*/
-
class ThreeLogDistancePropagationLossModel : public PropagationLossModel
{
public:
@@ -400,6 +414,8 @@
};
/**
+ * \ingroup propagation
+ *
* \brief Nakagami-m fast fading propagation loss model.
*
* The Nakagami-m distribution is applied to the power level. The probability
@@ -417,7 +433,6 @@
* For m = 1 the Nakagami-m distribution equals the Rayleigh distribution. Thus
* this model also implements Rayleigh distribution based fast fading.
*/
-
class NakagamiPropagationLossModel : public PropagationLossModel
{
public:
@@ -447,6 +462,8 @@
};
/**
+ * \ingroup propagation
+ *
* \brief Return a constant received power level independent of the transmit
* power
*
@@ -481,6 +498,8 @@
};
/**
+ * \ingroup propagation
+ *
* \brief The propagation loss is fixed for each pair of nodes and doesn't depend on their actual positions.
*
* This is supposed to be used by synthetic tests. Note that by default propagation loss is assumed to be symmetric.
@@ -520,6 +539,8 @@
};
/**
+ * \ingroup propagation
+ *
* \brief The propagation loss depends only on the distance (range) between transmitter and receiver.
*
* The single MaxRange attribute (units of meters) determines path loss.
--- a/src/spectrum/helper/adhoc-aloha-noack-ideal-phy-helper.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/helper/adhoc-aloha-noack-ideal-phy-helper.h Wed May 18 17:24:04 2011 -0700
@@ -36,6 +36,8 @@
class SpectrumChannel;
/**
+ * \ingroup spectrum
+ *
*
* create the NetDevice depicted in the figure
* @image html HdOfdmAlohaNoAck.png
--- a/src/spectrum/helper/spectrum-analyzer-helper.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/helper/spectrum-analyzer-helper.h Wed May 18 17:24:04 2011 -0700
@@ -37,6 +37,10 @@
class SpectrumChannel;
class SpectrumModel;
+/**
+ * \ingroup spectrum
+ *
+ */
class SpectrumAnalyzerHelper
{
public:
--- a/src/spectrum/helper/spectrum-helper.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/helper/spectrum-helper.h Wed May 18 17:24:04 2011 -0700
@@ -35,6 +35,10 @@
class NetDevice;
+/**
+ * \ingroup spectrum
+ *
+ */
class SpectrumChannelHelper
{
public:
@@ -146,6 +150,8 @@
/**
+ * \ingroup spectrum
+ *
* create and configure several SpectrumPhy instances and connect them to a channel.
*/
class SpectrumPhyHelper
--- a/src/spectrum/helper/waveform-generator-helper.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/helper/waveform-generator-helper.h Wed May 18 17:24:04 2011 -0700
@@ -37,6 +37,10 @@
class SpectrumChannel;
+/**
+ * \ingroup spectrum
+ *
+ */
class WaveformGeneratorHelper
{
public:
--- a/src/spectrum/model/aloha-noack-mac-header.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/aloha-noack-mac-header.h Wed May 18 17:24:04 2011 -0700
@@ -28,6 +28,10 @@
namespace ns3 {
+/**
+ * \ingroup spectrum
+ *
+ */
class AlohaNoackMacHeader : public Header
{
public:
--- a/src/spectrum/model/aloha-noack-net-device.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/aloha-noack-net-device.h Wed May 18 17:24:04 2011 -0700
@@ -44,6 +44,8 @@
/**
+ * \ingroup spectrum
+ *
* This devices implements the following features:
* - layer 3 protocol multiplexing
* - MAC addressing
--- a/src/spectrum/model/friis-spectrum-propagation-loss.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/friis-spectrum-propagation-loss.h Wed May 18 17:24:04 2011 -0700
@@ -30,6 +30,10 @@
class MobilityModel;
+/**
+ * \ingroup spectrum
+ *
+ */
class FriisSpectrumPropagationLossModel : public SpectrumPropagationLossModel
{
--- a/src/spectrum/model/half-duplex-ideal-phy.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/half-duplex-ideal-phy.h Wed May 18 17:24:04 2011 -0700
@@ -40,6 +40,8 @@
/**
+ * \ingroup spectrum
+ *
* This PHY layer implementation realizes an ideal OFDM PHY which
* transmits half-duplex (i.e., it can either receive or transmit at a
* given time). The device is ideal in the sense that:
--- a/src/spectrum/model/microwave-oven-spectrum-value-helper.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/microwave-oven-spectrum-value-helper.h Wed May 18 17:24:04 2011 -0700
@@ -29,6 +29,8 @@
/**
+ * \ingroup spectrum
+ *
* This class provides methods for the creation of SpectrumValue
* instances that mimic the Power Spectral Density of commercial
* microwave ovens based on the measurements reported in the following paper:
--- a/src/spectrum/model/multi-model-spectrum-channel.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/multi-model-spectrum-channel.h Wed May 18 17:24:04 2011 -0700
@@ -36,6 +36,10 @@
typedef std::map<SpectrumModelUid_t, SpectrumConverter> SpectrumConverterMap_t;
+/**
+ * \ingroup spectrum
+ *
+ */
class TxSpectrumModelInfo
{
public:
@@ -48,6 +52,10 @@
typedef std::map<SpectrumModelUid_t, TxSpectrumModelInfo> TxSpectrumModelInfoMap_t;
+/**
+ * \ingroup spectrum
+ *
+ */
class RxSpectrumModelInfo
{
public:
@@ -63,6 +71,8 @@
/**
+ * \ingroup spectrum
+ *
* This SpectrumChannel implementation can handle the presence of
* SpectrumPhy instances which can use
* different spectrum models, i.e., different SpectrumModel. The only
--- a/src/spectrum/model/non-communicating-net-device.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/non-communicating-net-device.h Wed May 18 17:24:04 2011 -0700
@@ -41,6 +41,8 @@
/**
+ * \ingroup spectrum
+ *
* This class implements a device which does not communicate, in the
* sense that it does not interact with the above protocol stack. The
* purpose of this NetDevice is to be used for devices such as
--- a/src/spectrum/model/single-model-spectrum-channel.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/single-model-spectrum-channel.h Wed May 18 17:24:04 2011 -0700
@@ -31,6 +31,8 @@
/**
+ * \ingroup spectrum
+ *
* @brief SpectrumChannel implementation which handles a single spectrum model
*
* All SpectrumPhy layers attached to this SpectrumChannel
--- a/src/spectrum/model/spectrum-analyzer.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/spectrum-analyzer.h Wed May 18 17:24:04 2011 -0700
@@ -36,6 +36,8 @@
/**
+ * \ingroup spectrum
+ *
* Simple SpectrumPhy implemetation that averages the spectrum power
* density of incoming transmissions to produce a spectrogram.
*
--- a/src/spectrum/model/spectrum-channel.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/spectrum-channel.h Wed May 18 17:24:04 2011 -0700
@@ -37,6 +37,8 @@
class PropagationDelayModel;
/**
+ * \ingroup spectrum
+ *
* Defines the interface for spectrum-aware channel implementations
*
*/
--- a/src/spectrum/model/spectrum-converter.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/spectrum-converter.h Wed May 18 17:24:04 2011 -0700
@@ -27,6 +27,8 @@
namespace ns3 {
/**
+ * \ingroup spectrum
+ *
* Class which implements a converter between SpectrumValue which are
* defined over different SpectrumModel. In more formal terms, this class
* allows conversion between different function spaces. In practical
--- a/src/spectrum/model/spectrum-error-model.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/spectrum-error-model.h Wed May 18 17:24:04 2011 -0700
@@ -32,6 +32,10 @@
+/**
+ * \ingroup spectrum
+ *
+ */
class SpectrumErrorModel : public Object
{
public:
@@ -43,6 +47,8 @@
/**
+ * \ingroup spectrum
+ *
* This class implements the error model described in this paper:
* N. Baldo and M. Miozzo, "Spectrum-aware Channel and PHY layer modeling
* for ns3", in Proceedings of International Workshop on Network
--- a/src/spectrum/model/spectrum-interference.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/spectrum-interference.h Wed May 18 17:24:04 2011 -0700
@@ -37,6 +37,8 @@
/**
+ * \ingroup spectrum
+ *
* This class implements a gaussian interference model, i.e., all
* incoming signals are added to the total interference.
*
--- a/src/spectrum/model/spectrum-model.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/spectrum-model.h Wed May 18 17:24:04 2011 -0700
@@ -26,9 +26,14 @@
namespace ns3 {
-
+/**
+ * \defgroup spectrum Spectrum Models
+ *
+ */
/**
+ * \ingroup spectrum
+ *
* The building block of a SpectrumModel. This struct models
* a frequency band defined by the frequency interval [fl, fc] and
* with center frequency fc. Typically, the center frequency will be
--- a/src/spectrum/model/spectrum-phy.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/spectrum-phy.h Wed May 18 17:24:04 2011 -0700
@@ -36,6 +36,8 @@
class NetDevice;
/**
+ * \ingroup spectrum
+ *
* Abstract base class for Spectrum-aware PHY layers
*
*/
--- a/src/spectrum/model/spectrum-propagation-loss-model.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/spectrum-propagation-loss-model.h Wed May 18 17:24:04 2011 -0700
@@ -32,6 +32,8 @@
/**
+ * \ingroup spectrum
+ *
* \brief spectrum-aware propagation loss model
*
* Interface for propagation loss models to be adopted when
--- a/src/spectrum/model/spectrum-type.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/spectrum-type.h Wed May 18 17:24:04 2011 -0700
@@ -31,6 +31,8 @@
/**
+ * \ingroup spectrum
+ *
* This class represent a type of signal that can be transmitted by
* SpectrumPhy instances over a SpectrumChannel. By means of this
* class a SpectrumPhy is able to recognize which type of signals it
@@ -62,6 +64,10 @@
+/**
+ * \ingroup spectrum
+ *
+ */
class SpectrumTypeFactory
{
--- a/src/spectrum/model/spectrum-value.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/spectrum-value.h Wed May 18 17:24:04 2011 -0700
@@ -33,6 +33,8 @@
typedef std::vector<double> Values;
/**
+ * \ingroup spectrum
+ *
* \brief Set of values corresponding to a given SpectrumModel
*
* This class implements a Function Space which can represent any
--- a/src/spectrum/model/waveform-generator.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/waveform-generator.h Wed May 18 17:24:04 2011 -0700
@@ -37,6 +37,8 @@
/**
+ * \ingroup spectrum
+ *
* Simple SpectrumPhy implementation that sends customizable waveform.
* The generated waveforms have a given Spectrum Power Density and
* duration (set with the SetResolution()) . The generator activates
--- a/src/spectrum/model/wifi-spectrum-value-helper.h Wed May 18 20:01:44 2011 -0400
+++ b/src/spectrum/model/wifi-spectrum-value-helper.h Wed May 18 17:24:04 2011 -0700
@@ -29,6 +29,8 @@
/**
+ * \ingroup spectrum
+ *
* this abstract class defines the interface for interacting with all WifiSpectrumValue implementations.
*
*/
@@ -71,6 +73,8 @@
/**
+ * \ingroup spectrum
+ *
* Implements WifiSpectrumValue for the 2.4 GHz ISM band only, with a
* 5 MHz spectrum resolution.
*
--- a/src/stats/model/basic-data-calculators.h Wed May 18 20:01:44 2011 -0400
+++ b/src/stats/model/basic-data-calculators.h Wed May 18 17:24:04 2011 -0700
@@ -26,6 +26,11 @@
namespace ns3 {
+/**
+ * \defgroup stats Statistics
+ *
+ */
+
//------------------------------------------------------------
//--------------------------------------------
template <typename T = uint32_t>
@@ -105,6 +110,10 @@
}
+/**
+ * \ingroup stats
+ *
+ */
//------------------------------------------------------------
//--------------------------------------------
template <typename T = uint32_t>
--- a/src/stats/model/data-collector.h Wed May 18 20:01:44 2011 -0400
+++ b/src/stats/model/data-collector.h Wed May 18 17:24:04 2011 -0700
@@ -28,6 +28,10 @@
namespace ns3 {
+/**
+ * \ingroup stats
+ *
+ */
class DataCalculator;
//------------------------------------------------------------
@@ -35,6 +39,10 @@
typedef std::list<Ptr<DataCalculator> > DataCalculatorList;
typedef std::list<std::pair<std::string, std::string> > MetadataList;
+/**
+ * \ingroup stats
+ *
+ */
class DataCollector : public Object {
public:
DataCollector();
--- a/src/stats/model/data-output-interface.h Wed May 18 20:01:44 2011 -0400
+++ b/src/stats/model/data-output-interface.h Wed May 18 17:24:04 2011 -0700
@@ -31,6 +31,10 @@
//------------------------------------------------------------
//--------------------------------------------
+/**
+ * \ingroup stats
+ *
+ */
class DataOutputInterface : public Object {
public:
DataOutputInterface();
@@ -49,6 +53,10 @@
// end class DataOutputInterface
};
+/**
+ * \ingroup stats
+ *
+ */
class DataOutputCallback {
public:
virtual ~DataOutputCallback() {}
--- a/src/stats/model/omnet-data-output.h Wed May 18 20:01:44 2011 -0400
+++ b/src/stats/model/omnet-data-output.h Wed May 18 17:24:04 2011 -0700
@@ -30,6 +30,10 @@
//------------------------------------------------------------
//--------------------------------------------
+/**
+ * \ingroup stats
+ *
+ */
class OmnetDataOutput : public DataOutputInterface {
public:
OmnetDataOutput();
--- a/src/stats/model/packet-data-calculators.h Wed May 18 20:01:44 2011 -0400
+++ b/src/stats/model/packet-data-calculators.h Wed May 18 17:24:04 2011 -0700
@@ -28,6 +28,10 @@
namespace ns3 {
+/**
+ * \ingroup stats
+ *
+ */
class PacketCounterCalculator : public CounterCalculator<uint32_t> {
public:
PacketCounterCalculator();
@@ -44,6 +48,10 @@
};
+/**
+ * \ingroup stats
+ *
+ */
class PacketSizeMinMaxAvgTotalCalculator :
public MinMaxAvgTotalCalculator<uint32_t> {
public:
--- a/src/stats/model/sqlite-data-output.h Wed May 18 20:01:44 2011 -0400
+++ b/src/stats/model/sqlite-data-output.h Wed May 18 17:24:04 2011 -0700
@@ -33,6 +33,10 @@
//------------------------------------------------------------
//--------------------------------------------
+/**
+ * \ingroup stats
+ *
+ */
class SqliteDataOutput : public DataOutputInterface {
public:
SqliteDataOutput();
--- a/src/stats/model/time-data-calculators.h Wed May 18 20:01:44 2011 -0400
+++ b/src/stats/model/time-data-calculators.h Wed May 18 17:24:04 2011 -0700
@@ -31,6 +31,8 @@
//------------------------------------------------------------
//--------------------------------------------
/**
+ * \ingroup stats
+ *
* Unfortunately, templating the base MinMaxAvgTotalCalculator to
* operate over Time values isn't straightforward. The main issues
* are setting the maximum value, which can be worked around easily
--- a/src/tools/model/average.h Wed May 18 20:01:44 2011 -0400
+++ b/src/tools/model/average.h Wed May 18 17:24:04 2011 -0700
@@ -28,7 +28,18 @@
namespace ns3 {
-/// Simple average, min, max and std. deviation calculator
+/**
+ * \defgroup tools Tools
+ *
+ */
+
+/**
+ * \ingroup tools
+ *
+ * Simple average, min, max and std. deviation calculator
+ *
+ */
+
template <typename T = double>
class Average
{
--- a/src/tools/model/delay-jitter-estimation.h Wed May 18 20:01:44 2011 -0400
+++ b/src/tools/model/delay-jitter-estimation.h Wed May 18 17:24:04 2011 -0700
@@ -7,6 +7,8 @@
namespace ns3 {
/**
+ * \ingroup tools
+ *
* \brief quick and dirty delay and jitter estimation
*
*/
--- a/src/tools/model/event-garbage-collector.h Wed May 18 20:01:44 2011 -0400
+++ b/src/tools/model/event-garbage-collector.h Wed May 18 17:24:04 2011 -0700
@@ -27,6 +27,8 @@
namespace ns3 {
/**
+ * \ingroup tools
+ *
* \brief An object that tracks scheduled events and automatically
* cancels them when it is destroyed. It is useful in situations
* where multiple instances of the same type of event can
--- a/src/tools/model/gnuplot.h Wed May 18 20:01:44 2011 -0400
+++ b/src/tools/model/gnuplot.h Wed May 18 17:24:04 2011 -0700
@@ -28,6 +28,8 @@
namespace ns3 {
/**
+ * \ingroup tools
+ *
* \brief Abstract class to store a plot line to be used by ns3::Gnuplot.
*
* This class contains a reference counted data object in m_data. The data
--- a/src/virtual-net-device/model/virtual-net-device.h Wed May 18 20:01:44 2011 -0400
+++ b/src/virtual-net-device/model/virtual-net-device.h Wed May 18 17:24:04 2011 -0700
@@ -33,6 +33,13 @@
/**
+ * \defgroup virtualdevice Virtual Device
+ *
+ */
+
+/**
+ * \ingroup virtualdevice
+ *
* \class VirtualNetDevice
* \brief A virtual device, similar to Linux TUN/TAP interfaces.
*
--- a/src/visualizer/model/pyviz.h Wed May 18 20:01:44 2011 -0400
+++ b/src/visualizer/model/pyviz.h Wed May 18 17:24:04 2011 -0700
@@ -38,6 +38,8 @@
namespace ns3 {
/**
+ * \ingroup visualizer
+ *
* \brief helper class to be used by the visualizer
* \internal
*
--- a/src/visualizer/model/visual-simulator-impl.h Wed May 18 20:01:44 2011 -0400
+++ b/src/visualizer/model/visual-simulator-impl.h Wed May 18 17:24:04 2011 -0700
@@ -27,6 +27,13 @@
/**
+ * \defgroup visualizer Visualizer
+ *
+ */
+
+/**
+ * \ingroup visualizer
+ *
* \brief A replacement simulator that starts the visualizer
* \internal
*