Make some more modules show up on doxygen modules page

src/csma-layout/model/csma-star-helper.h

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

src/mpi/model/distributed-simulator-impl.h

@@ -29,6 +29,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup mpi
+ *
  * \brief Structure used for all-reduce LBTS computation
  */
 class LbtsMessage
@@ -82,6 +84,8 @@ private:
 };
 
 /**
+ * \ingroup mpi
+ *
  * \brief distributed simulator implementation using lookahead
  */
 class DistributedSimulatorImpl : public SimulatorImpl

src/mpi/model/mpi-interface.h

@@ -33,6 +33,11 @@ typedef struct ompi_request_t* MPI_Request;
 
 namespace ns3 {
 
+/**
+ * \defgroup mpi MPI Distributed Simulation
+ *
+ */
+
 /**
  * maximum MPI message size for easy
  * buffer creation
@@ -40,6 +45,8 @@ namespace ns3 {
 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 @@ private:
 class Packet;
 
 /**
+ * \ingroup mpi
+ *
  * Interface between ns-3 and MPI
  */
 class MpiInterface

src/mpi/model/mpi-receiver.h

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

src/netanim/model/animation-interface.h

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

src/netanim/model/canvas-location.h

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

src/point-to-point-layout/model/point-to-point-dumbbell.h

@@ -31,6 +31,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup pointtopointlayout
+ *
  * \brief A helper to make it easier to create a dumbbell topology
  * with p2p links
  */

src/point-to-point-layout/model/point-to-point-grid.h

@@ -30,6 +30,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup pointtopointlayout
+ *
  * \brief A helper to make it easier to create a grid topology
  * with p2p links
  */

src/point-to-point-layout/model/point-to-point-star.h

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

src/propagation/model/cost231-propagation-loss-model.h

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

src/propagation/model/jakes-propagation-loss-model.h

@@ -27,6 +27,8 @@ namespace ns3 {
 
 
 /**
+ * \ingroup propagation
+ *
  * \brief a Jakes propagation loss model
  *
  * The Jakes propagation loss model implemented here is 

src/propagation/model/propagation-delay-model.h

@@ -30,6 +30,8 @@ namespace ns3 {
 class MobilityModel;
 
 /**
+ * \ingroup propagation
+ *
  * \brief calculate a propagation delay.
  */
 class PropagationDelayModel : public Object
@@ -49,6 +51,8 @@ public:
 };
 
 /**
+ * \ingroup propagation
+ *
  * \brief the propagation delay is random
  */
 class RandomPropagationDelayModel : public PropagationDelayModel
@@ -67,6 +71,8 @@ private:
 };
 
 /**
+ * \ingroup propagation
+ *
  * \brief the propagation speed is constant
  */
 class ConstantSpeedPropagationDelayModel : public PropagationDelayModel

src/propagation/model/propagation-loss-model.h

@@ -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 @@ private:
 };
 
 /**
+ * \ingroup propagation
+ *
  * \brief The propagation loss follows a random distribution.
  */ 
 class RandomPropagationLossModel : public PropagationLossModel
@@ -97,6 +106,8 @@ private:
 };
 
 /**
+ * \ingroup propagation
+ *
  * \brief a Friis propagation loss model
  *
  * The Friis propagation loss model was first described in
@@ -193,7 +204,8 @@ private:
   double m_minDistance;
 };
 
-/*
+/**
+ * \ingroup propagation
  *
  * \brief a Two-Ray Ground propagation loss model ported from NS2
  *
@@ -215,7 +227,6 @@ private:
  *
  * \f$ dCross = \frac{(4 * pi * Ht * Hr)}{lambda} \f$
  */
-
 class TwoRayGroundPropagationLossModel : public PropagationLossModel
 {
 public:
@@ -285,6 +296,8 @@ private:
 };
 
 /**
+ * \ingroup propagation
+ *
  * \brief a log distance propagation model.
  *
  * This model calculates the reception power with a so-called
@@ -334,6 +347,8 @@ private:
 };
 
 /**
+ * \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 @@ L_0 + 10 \cdot n_0 \log_{10}(\frac{d_1}{d_0}) + 10 \cdot n_1 \log_{10}(\frac{d_2
  * 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 @@ private:
 };
 
 /**
+ * \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 @@ private:
  * 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 @@ private:
 };
 
 /**
+ * \ingroup propagation
+ *
  * \brief Return a constant received power level independent of the transmit 
  *  power
  *
@@ -481,6 +498,8 @@ private:
 };
 
 /**
+ * \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 @@ private:
 };
 
 /**
+ * \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.

src/spectrum/helper/adhoc-aloha-noack-ideal-phy-helper.h

@@ -36,6 +36,8 @@ class SpectrumValue;
 class SpectrumChannel;
 
 /**
+ * \ingroup spectrum
+ *
  *
  * create the NetDevice depicted in the figure
  * @image html HdOfdmAlohaNoAck.png

src/spectrum/helper/spectrum-analyzer-helper.h

@@ -37,6 +37,10 @@ class SpectrumValue;
 class SpectrumChannel;
 class SpectrumModel;
 
+/**
+ * \ingroup spectrum
+ *
+ */
 class SpectrumAnalyzerHelper
 {
 public:

src/spectrum/helper/spectrum-helper.h

@@ -35,6 +35,10 @@ class Node;
 class NetDevice;
 
 
+/**
+ * \ingroup spectrum
+ *
+ */
 class SpectrumChannelHelper
 {
 public:
@@ -146,6 +150,8 @@ private:
 
 
 /**
+ * \ingroup spectrum
+ *
  * create and configure several SpectrumPhy instances and connect them to a channel.
  */
 class SpectrumPhyHelper

src/spectrum/helper/waveform-generator-helper.h

@@ -37,6 +37,10 @@ class SpectrumValue;
 class SpectrumChannel;
 
 
+/**
+ * \ingroup spectrum
+ *
+ */
 class WaveformGeneratorHelper
 {
 public:

src/spectrum/model/aloha-noack-mac-header.h

@@ -28,6 +28,10 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup spectrum
+ *
+ */
 class AlohaNoackMacHeader : public Header
 {
 public:

src/spectrum/model/aloha-noack-net-device.h

@@ -44,6 +44,8 @@ class Queue;
 
 
 /**
+ * \ingroup spectrum
+ *
  * This devices implements the following features:
  *  - layer 3 protocol multiplexing
  *  - MAC addressing

src/spectrum/model/friis-spectrum-propagation-loss.h

@@ -30,6 +30,10 @@ namespace ns3 {
 class MobilityModel;
 
 
+/**
+ * \ingroup spectrum
+ *
+ */
 class FriisSpectrumPropagationLossModel : public SpectrumPropagationLossModel
 {
 

src/spectrum/model/half-duplex-ideal-phy.h

@@ -40,6 +40,8 @@ namespace ns3 {
 
 
 /**
+ * \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:

src/spectrum/model/microwave-oven-spectrum-value-helper.h

@@ -29,6 +29,8 @@ namespace ns3 {
 
 
 /**
+ * \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:

src/spectrum/model/multi-model-spectrum-channel.h

@@ -36,6 +36,10 @@ namespace ns3 {
 typedef std::map<SpectrumModelUid_t, SpectrumConverter> SpectrumConverterMap_t;
 
 
+/**
+ * \ingroup spectrum
+ *
+ */
 class TxSpectrumModelInfo
 {
 public:
@@ -48,6 +52,10 @@ public:
 typedef std::map<SpectrumModelUid_t, TxSpectrumModelInfo> TxSpectrumModelInfoMap_t;
 
 
+/**
+ * \ingroup spectrum
+ *
+ */
 class RxSpectrumModelInfo
 {
 public:
@@ -63,6 +71,8 @@ typedef std::map<SpectrumModelUid_t, RxSpectrumModelInfo> RxSpectrumModelInfoMap
 
 
 /**
+ * \ingroup spectrum
+ *
  * This SpectrumChannel implementation can handle the presence of
  * SpectrumPhy instances which can use
  * different spectrum models, i.e.,  different SpectrumModel. The only

src/spectrum/model/non-communicating-net-device.h

@@ -41,6 +41,8 @@ class Queue;
 
 
 /**
+ * \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

src/spectrum/model/single-model-spectrum-channel.h

@@ -31,6 +31,8 @@ namespace ns3 {
 
 
 /**
+ * \ingroup spectrum
+ *
  * @brief SpectrumChannel implementation which handles a single spectrum model
  *
  * All SpectrumPhy layers attached to this SpectrumChannel

src/spectrum/model/spectrum-analyzer.h

@@ -36,6 +36,8 @@ namespace ns3 {
 
 
 /**
+ * \ingroup spectrum
+ *
  * Simple SpectrumPhy implemetation that averages the spectrum power
  * density of incoming transmissions to produce a spectrogram.
  *

src/spectrum/model/spectrum-channel.h

@@ -37,6 +37,8 @@ class SpectrumPropagationLossModel;
 class PropagationDelayModel;
 
 /**
+ * \ingroup spectrum
+ *
  * Defines the interface for spectrum-aware channel implementations
  *
  */

src/spectrum/model/spectrum-converter.h

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

src/spectrum/model/spectrum-error-model.h

@@ -32,6 +32,10 @@ namespace ns3 {
 
 
 
+/**
+ * \ingroup spectrum
+ *
+ */
 class SpectrumErrorModel :  public Object
 {
 public:
@@ -43,6 +47,8 @@ public:
 
 
 /**
+ * \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

src/spectrum/model/spectrum-interference.h

@@ -37,6 +37,8 @@ class SpectrumErrorModel;
 
 
 /**
+ * \ingroup spectrum
+ *
  * This class implements a gaussian interference model, i.e., all
  * incoming signals are added to the total interference.
  *

src/spectrum/model/spectrum-model.h

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

src/spectrum/model/spectrum-phy.h

@@ -36,6 +36,8 @@ class SpectrumModel;
 class NetDevice;
 
 /**
+ * \ingroup spectrum
+ *
  * Abstract base class for Spectrum-aware PHY layers
  *
  */

src/spectrum/model/spectrum-propagation-loss-model.h

@@ -32,6 +32,8 @@ namespace ns3 {
 
 
 /**
+ * \ingroup spectrum
+ *
  * \brief spectrum-aware propagation loss model
  *
  * Interface for propagation loss models to be adopted when

src/spectrum/model/spectrum-type.h

@@ -31,6 +31,8 @@ namespace ns3 {
 
 
 /**
+ * \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 @@ std::ostream& operator<< (std::ostream& os, const SpectrumType& rhs);
 
 
 
+/**
+ * \ingroup spectrum
+ *
+ */
 class SpectrumTypeFactory
 {
 

src/spectrum/model/spectrum-value.h

@@ -33,6 +33,8 @@ namespace ns3 {
 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

src/spectrum/model/waveform-generator.h

@@ -37,6 +37,8 @@ namespace ns3 {
 
 
 /**
+ * \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

src/spectrum/model/wifi-spectrum-value-helper.h

@@ -29,6 +29,8 @@ namespace ns3 {
 
 
 /**
+ * \ingroup spectrum
+ *
  * this abstract class defines the interface for interacting with all WifiSpectrumValue implementations.
  *
  */
@@ -71,6 +73,8 @@ public:
 
 
 /**
+ * \ingroup spectrum
+ *
  * Implements WifiSpectrumValue for the 2.4 GHz ISM band only, with a
  * 5 MHz spectrum resolution.
  *

src/stats/model/basic-data-calculators.h

@@ -26,6 +26,11 @@
 
 namespace ns3 {
 
+/**
+ * \defgroup stats Statistics
+ *
+ */
+
 //------------------------------------------------------------
 //--------------------------------------------
 template <typename T  = uint32_t>
@@ -105,6 +110,10 @@ MinMaxAvgTotalCalculator<T>::Output(DataOutputCallback &callback) const
 }
 
 
+/**
+ * \ingroup stats
+ *
+ */
 //------------------------------------------------------------
 //--------------------------------------------
 template <typename T  = uint32_t>

src/stats/model/data-collector.h

@@ -28,6 +28,10 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup stats
+ *
+ */
 class DataCalculator;
 
 //------------------------------------------------------------
@@ -35,6 +39,10 @@ class DataCalculator;
 typedef std::list<Ptr<DataCalculator> > DataCalculatorList;
 typedef std::list<std::pair<std::string, std::string> > MetadataList;
 
+/**
+ * \ingroup stats
+ *
+ */
 class DataCollector : public Object {
 public:
   DataCollector();

src/stats/model/data-output-interface.h

@@ -31,6 +31,10 @@ class DataCollector;
 
 //------------------------------------------------------------
 //--------------------------------------------
+/**
+ * \ingroup stats
+ *
+ */
 class DataOutputInterface : public Object {
 public:
   DataOutputInterface();
@@ -49,6 +53,10 @@ protected:
   // end class DataOutputInterface
 };
 
+/**
+ * \ingroup stats
+ *
+ */
 class DataOutputCallback {
 public:
   virtual ~DataOutputCallback() {}

src/stats/model/omnet-data-output.h

@@ -30,6 +30,10 @@ namespace ns3 {
 
 //------------------------------------------------------------
 //--------------------------------------------
+/**
+ * \ingroup stats
+ *
+ */
 class OmnetDataOutput : public DataOutputInterface {
 public:
   OmnetDataOutput();

src/stats/model/packet-data-calculators.h

@@ -28,6 +28,10 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup stats
+ *
+ */
 class PacketCounterCalculator : public CounterCalculator<uint32_t> {
 public:
   PacketCounterCalculator();
@@ -44,6 +48,10 @@ protected:
 };
 
 
+/**
+ * \ingroup stats
+ *
+ */
 class PacketSizeMinMaxAvgTotalCalculator :
   public MinMaxAvgTotalCalculator<uint32_t> {
 public:

src/stats/model/sqlite-data-output.h

@@ -33,6 +33,10 @@ namespace ns3 {
 
 //------------------------------------------------------------
 //--------------------------------------------
+/**
+ * \ingroup stats
+ *
+ */
 class SqliteDataOutput : public DataOutputInterface {
 public:
   SqliteDataOutput();

src/stats/model/time-data-calculators.h

@@ -31,6 +31,8 @@ namespace ns3 {
 //------------------------------------------------------------
 //--------------------------------------------
 /**
+ * \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

src/tools/model/average.h

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

src/tools/model/delay-jitter-estimation.h

@@ -7,6 +7,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup tools
+ *
  * \brief quick and dirty delay and jitter estimation
  *
  */

src/tools/model/event-garbage-collector.h

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

src/tools/model/gnuplot.h

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

src/virtual-net-device/model/virtual-net-device.h

@@ -33,6 +33,13 @@ namespace ns3 {
 
 
 /**
+ * \defgroup virtualdevice Virtual Device
+ *
+ */
+
+/**
+ * \ingroup virtualdevice
+ *
  * \class VirtualNetDevice
  * \brief A virtual device, similar to Linux TUN/TAP interfaces.
  *

src/visualizer/model/pyviz.h

@@ -38,6 +38,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup visualizer
+ *
  * \brief helper class to be used by the visualizer
  * \internal
  *

src/visualizer/model/visual-simulator-impl.h

@@ -27,6 +27,13 @@ namespace ns3 {
 
 
 /**
+ * \defgroup  visualizer Visualizer
+ *
+ */
+
+/**
+ * \ingroup visualizer
+ *
  * \brief A replacement simulator that starts the visualizer
  * \internal
  *