Make some more modules show up on doxygen modules page ns-3.11-RC2
authorMitch Watrous <watrous@u.washington.edu>
Wed, 18 May 2011 17:24:04 -0700
changeset 72410a7a16b599e8
parent 7240 395988f30476
child 7242 83a2a4a40c6b
Make some more modules show up on doxygen modules page
src/csma-layout/model/csma-star-helper.h
src/mpi/model/distributed-simulator-impl.h
src/mpi/model/mpi-interface.h
src/mpi/model/mpi-receiver.h
src/netanim/model/animation-interface.h
src/netanim/model/canvas-location.h
src/point-to-point-layout/model/point-to-point-dumbbell.h
src/point-to-point-layout/model/point-to-point-grid.h
src/point-to-point-layout/model/point-to-point-star.h
src/propagation/model/cost231-propagation-loss-model.h
src/propagation/model/jakes-propagation-loss-model.h
src/propagation/model/propagation-delay-model.h
src/propagation/model/propagation-loss-model.h
src/spectrum/helper/adhoc-aloha-noack-ideal-phy-helper.h
src/spectrum/helper/spectrum-analyzer-helper.h
src/spectrum/helper/spectrum-helper.h
src/spectrum/helper/waveform-generator-helper.h
src/spectrum/model/aloha-noack-mac-header.h
src/spectrum/model/aloha-noack-net-device.h
src/spectrum/model/friis-spectrum-propagation-loss.h
src/spectrum/model/half-duplex-ideal-phy.h
src/spectrum/model/microwave-oven-spectrum-value-helper.h
src/spectrum/model/multi-model-spectrum-channel.h
src/spectrum/model/non-communicating-net-device.h
src/spectrum/model/single-model-spectrum-channel.h
src/spectrum/model/spectrum-analyzer.h
src/spectrum/model/spectrum-channel.h
src/spectrum/model/spectrum-converter.h
src/spectrum/model/spectrum-error-model.h
src/spectrum/model/spectrum-interference.h
src/spectrum/model/spectrum-model.h
src/spectrum/model/spectrum-phy.h
src/spectrum/model/spectrum-propagation-loss-model.h
src/spectrum/model/spectrum-type.h
src/spectrum/model/spectrum-value.h
src/spectrum/model/waveform-generator.h
src/spectrum/model/wifi-spectrum-value-helper.h
src/stats/model/basic-data-calculators.h
src/stats/model/data-collector.h
src/stats/model/data-output-interface.h
src/stats/model/omnet-data-output.h
src/stats/model/packet-data-calculators.h
src/stats/model/sqlite-data-output.h
src/stats/model/time-data-calculators.h
src/tools/model/average.h
src/tools/model/delay-jitter-estimation.h
src/tools/model/event-garbage-collector.h
src/tools/model/gnuplot.h
src/virtual-net-device/model/virtual-net-device.h
src/visualizer/model/pyviz.h
src/visualizer/model/visual-simulator-impl.h
     1.1 --- a/src/csma-layout/model/csma-star-helper.h	Wed May 18 20:01:44 2011 -0400
     1.2 +++ b/src/csma-layout/model/csma-star-helper.h	Wed May 18 17:24:04 2011 -0700
     1.3 @@ -29,12 +29,12 @@
     1.4  namespace ns3 {
     1.5  
     1.6  /**
     1.7 - * \defgroup csmastarhelper CSMA Star Helper
     1.8 + * \defgroup csmalayout CSMA Layout Helpers
     1.9   *
    1.10   */
    1.11  
    1.12  /**
    1.13 - * \ingroup csmastarhelper
    1.14 + * \ingroup csmalayout
    1.15   *
    1.16   * \brief A helper to make it easier to create a star topology
    1.17   * with Csma links
     2.1 --- a/src/mpi/model/distributed-simulator-impl.h	Wed May 18 20:01:44 2011 -0400
     2.2 +++ b/src/mpi/model/distributed-simulator-impl.h	Wed May 18 17:24:04 2011 -0700
     2.3 @@ -29,6 +29,8 @@
     2.4  namespace ns3 {
     2.5  
     2.6  /**
     2.7 + * \ingroup mpi
     2.8 + *
     2.9   * \brief Structure used for all-reduce LBTS computation
    2.10   */
    2.11  class LbtsMessage
    2.12 @@ -82,6 +84,8 @@
    2.13  };
    2.14  
    2.15  /**
    2.16 + * \ingroup mpi
    2.17 + *
    2.18   * \brief distributed simulator implementation using lookahead
    2.19   */
    2.20  class DistributedSimulatorImpl : public SimulatorImpl
     3.1 --- a/src/mpi/model/mpi-interface.h	Wed May 18 20:01:44 2011 -0400
     3.2 +++ b/src/mpi/model/mpi-interface.h	Wed May 18 17:24:04 2011 -0700
     3.3 @@ -34,12 +34,19 @@
     3.4  namespace ns3 {
     3.5  
     3.6  /**
     3.7 + * \defgroup mpi MPI Distributed Simulation
     3.8 + *
     3.9 + */
    3.10 +
    3.11 +/**
    3.12   * maximum MPI message size for easy
    3.13   * buffer creation
    3.14   */
    3.15  const uint32_t MAX_MPI_MSG_SIZE = 2000;
    3.16  
    3.17  /**
    3.18 + * \ingroup mpi
    3.19 + *
    3.20   * Define a class for tracking the non-block sends
    3.21   */
    3.22  class SentBuffer
    3.23 @@ -69,6 +76,8 @@
    3.24  class Packet;
    3.25  
    3.26  /**
    3.27 + * \ingroup mpi
    3.28 + *
    3.29   * Interface between ns-3 and MPI
    3.30   */
    3.31  class MpiInterface
     4.1 --- a/src/mpi/model/mpi-receiver.h	Wed May 18 20:01:44 2011 -0400
     4.2 +++ b/src/mpi/model/mpi-receiver.h	Wed May 18 17:24:04 2011 -0700
     4.3 @@ -27,6 +27,8 @@
     4.4  namespace ns3 {
     4.5  
     4.6  /**
     4.7 + * \ingroup mpi
     4.8 + *
     4.9   * Class to aggregate to a NetDevice if it supports MPI capability
    4.10   * 
    4.11   * MpiInterface::ReceiveMessages () needs to send packets to a NetDevice
     5.1 --- a/src/netanim/model/animation-interface.h	Wed May 18 20:01:44 2011 -0400
     5.2 +++ b/src/netanim/model/animation-interface.h	Wed May 18 17:24:04 2011 -0700
     5.3 @@ -31,9 +31,17 @@
     5.4  
     5.5  
     5.6  namespace ns3 {
     5.7 +
     5.8 +/**
     5.9 + * \defgroup netanim Animation
    5.10 + *
    5.11 + */
    5.12 +
    5.13  class NetModel;
    5.14  
    5.15  /**
    5.16 + * \ingroup netanim
    5.17 + *
    5.18   * \brief Interface to network animator
    5.19   *
    5.20   * Provides functions that facilitate communications with an
     6.1 --- a/src/netanim/model/canvas-location.h	Wed May 18 20:01:44 2011 -0400
     6.2 +++ b/src/netanim/model/canvas-location.h	Wed May 18 17:24:04 2011 -0700
     6.3 @@ -26,7 +26,10 @@
     6.4  
     6.5  namespace ns3 {
     6.6  
     6.7 +
     6.8  /**
     6.9 + * \ingroup netanim
    6.10 + *
    6.11   * \brief Keep track of the current location of an object
    6.12   *
    6.13   * This can be used anytime a logical node location is needed
     7.1 --- a/src/point-to-point-layout/model/point-to-point-dumbbell.h	Wed May 18 20:01:44 2011 -0400
     7.2 +++ b/src/point-to-point-layout/model/point-to-point-dumbbell.h	Wed May 18 17:24:04 2011 -0700
     7.3 @@ -31,6 +31,8 @@
     7.4  namespace ns3 {
     7.5  
     7.6  /**
     7.7 + * \ingroup pointtopointlayout
     7.8 + *
     7.9   * \brief A helper to make it easier to create a dumbbell topology
    7.10   * with p2p links
    7.11   */
     8.1 --- a/src/point-to-point-layout/model/point-to-point-grid.h	Wed May 18 20:01:44 2011 -0400
     8.2 +++ b/src/point-to-point-layout/model/point-to-point-grid.h	Wed May 18 17:24:04 2011 -0700
     8.3 @@ -30,6 +30,8 @@
     8.4  namespace ns3 {
     8.5  
     8.6  /**
     8.7 + * \ingroup pointtopointlayout
     8.8 + *
     8.9   * \brief A helper to make it easier to create a grid topology
    8.10   * with p2p links
    8.11   */
     9.1 --- a/src/point-to-point-layout/model/point-to-point-star.h	Wed May 18 20:01:44 2011 -0400
     9.2 +++ b/src/point-to-point-layout/model/point-to-point-star.h	Wed May 18 17:24:04 2011 -0700
     9.3 @@ -29,6 +29,13 @@
     9.4  namespace ns3 {
     9.5  
     9.6  /**
     9.7 + * \defgroup pointtopointlayout Point-to-Point Layout Helpers
     9.8 + *
     9.9 + */
    9.10 +
    9.11 +/**
    9.12 + * \ingroup pointtopointlayout
    9.13 + *
    9.14   * \brief A helper to make it easier to create a star topology
    9.15   * with PointToPoint links
    9.16   */
    10.1 --- a/src/propagation/model/cost231-propagation-loss-model.h	Wed May 18 20:01:44 2011 -0400
    10.2 +++ b/src/propagation/model/cost231-propagation-loss-model.h	Wed May 18 17:24:04 2011 -0700
    10.3 @@ -27,8 +27,11 @@
    10.4  
    10.5  namespace ns3 {
    10.6  
    10.7 -/*
    10.8 +/**
    10.9 + * \ingroup propagation
   10.10 + *
   10.11   *  \brief The COST-Hata-Model is the most often cited of the COST 231 models.
   10.12 + *
   10.13   *  Also called the Hata Model PCS Extension, it is a radio propagation model
   10.14   *  that extends the Hata Model (which in turn is based on the Okumura Model)
   10.15   *  to cover a more elaborated range of frequencies. COST (COperation
    11.1 --- a/src/propagation/model/jakes-propagation-loss-model.h	Wed May 18 20:01:44 2011 -0400
    11.2 +++ b/src/propagation/model/jakes-propagation-loss-model.h	Wed May 18 17:24:04 2011 -0700
    11.3 @@ -27,6 +27,8 @@
    11.4  
    11.5  
    11.6  /**
    11.7 + * \ingroup propagation
    11.8 + *
    11.9   * \brief a Jakes propagation loss model
   11.10   *
   11.11   * The Jakes propagation loss model implemented here is 
    12.1 --- a/src/propagation/model/propagation-delay-model.h	Wed May 18 20:01:44 2011 -0400
    12.2 +++ b/src/propagation/model/propagation-delay-model.h	Wed May 18 17:24:04 2011 -0700
    12.3 @@ -30,6 +30,8 @@
    12.4  class MobilityModel;
    12.5  
    12.6  /**
    12.7 + * \ingroup propagation
    12.8 + *
    12.9   * \brief calculate a propagation delay.
   12.10   */
   12.11  class PropagationDelayModel : public Object
   12.12 @@ -49,6 +51,8 @@
   12.13  };
   12.14  
   12.15  /**
   12.16 + * \ingroup propagation
   12.17 + *
   12.18   * \brief the propagation delay is random
   12.19   */
   12.20  class RandomPropagationDelayModel : public PropagationDelayModel
   12.21 @@ -67,6 +71,8 @@
   12.22  };
   12.23  
   12.24  /**
   12.25 + * \ingroup propagation
   12.26 + *
   12.27   * \brief the propagation speed is constant
   12.28   */
   12.29  class ConstantSpeedPropagationDelayModel : public PropagationDelayModel
    13.1 --- a/src/propagation/model/propagation-loss-model.h	Wed May 18 20:01:44 2011 -0400
    13.2 +++ b/src/propagation/model/propagation-loss-model.h	Wed May 18 17:24:04 2011 -0700
    13.3 @@ -31,9 +31,16 @@
    13.4  
    13.5  namespace ns3 {
    13.6  
    13.7 +/**
    13.8 + * \defgroup propagation Propagation Models
    13.9 + *
   13.10 + */
   13.11 +
   13.12  class MobilityModel;
   13.13  
   13.14  /**
   13.15 + * \ingroup propagation
   13.16 + *
   13.17   * \brief Modelize the propagation loss through a transmission medium
   13.18   *
   13.19   * Calculate the receive power (dbm) from a transmit power (dbm)
   13.20 @@ -77,6 +84,8 @@
   13.21  };
   13.22  
   13.23  /**
   13.24 + * \ingroup propagation
   13.25 + *
   13.26   * \brief The propagation loss follows a random distribution.
   13.27   */ 
   13.28  class RandomPropagationLossModel : public PropagationLossModel
   13.29 @@ -97,6 +106,8 @@
   13.30  };
   13.31  
   13.32  /**
   13.33 + * \ingroup propagation
   13.34 + *
   13.35   * \brief a Friis propagation loss model
   13.36   *
   13.37   * The Friis propagation loss model was first described in
   13.38 @@ -193,7 +204,8 @@
   13.39    double m_minDistance;
   13.40  };
   13.41  
   13.42 -/*
   13.43 +/**
   13.44 + * \ingroup propagation
   13.45   *
   13.46   * \brief a Two-Ray Ground propagation loss model ported from NS2
   13.47   *
   13.48 @@ -215,7 +227,6 @@
   13.49   *
   13.50   * \f$ dCross = \frac{(4 * pi * Ht * Hr)}{lambda} \f$
   13.51   */
   13.52 -
   13.53  class TwoRayGroundPropagationLossModel : public PropagationLossModel
   13.54  {
   13.55  public:
   13.56 @@ -285,6 +296,8 @@
   13.57  };
   13.58  
   13.59  /**
   13.60 + * \ingroup propagation
   13.61 + *
   13.62   * \brief a log distance propagation model.
   13.63   *
   13.64   * This model calculates the reception power with a so-called
   13.65 @@ -334,6 +347,8 @@
   13.66  };
   13.67  
   13.68  /**
   13.69 + * \ingroup propagation
   13.70 + *
   13.71   * \brief A log distance path loss propagation model with three distance
   13.72   * fields. This model is the same as ns3::LogDistancePropagationLossModel
   13.73   * except that it has three distance fields: near, middle and far with
   13.74 @@ -371,7 +386,6 @@
   13.75   * reference distance defaults to 1m and reference loss defaults to
   13.76   * ns3::FriisPropagationLossModel with 5.15 GHz and is thus \f$ L_0 \f$ = 46.67 dB.
   13.77   */
   13.78 -
   13.79  class ThreeLogDistancePropagationLossModel : public PropagationLossModel
   13.80  {
   13.81  public:
   13.82 @@ -400,6 +414,8 @@
   13.83  };
   13.84  
   13.85  /**
   13.86 + * \ingroup propagation
   13.87 + *
   13.88   * \brief Nakagami-m fast fading propagation loss model.
   13.89   *
   13.90   * The Nakagami-m distribution is applied to the power level. The probability
   13.91 @@ -417,7 +433,6 @@
   13.92   * For m = 1 the Nakagami-m distribution equals the Rayleigh distribution. Thus
   13.93   * this model also implements Rayleigh distribution based fast fading.
   13.94   */
   13.95 -
   13.96  class NakagamiPropagationLossModel : public PropagationLossModel
   13.97  {
   13.98  public:
   13.99 @@ -447,6 +462,8 @@
  13.100  };
  13.101  
  13.102  /**
  13.103 + * \ingroup propagation
  13.104 + *
  13.105   * \brief Return a constant received power level independent of the transmit 
  13.106   *  power
  13.107   *
  13.108 @@ -481,6 +498,8 @@
  13.109  };
  13.110  
  13.111  /**
  13.112 + * \ingroup propagation
  13.113 + *
  13.114   * \brief The propagation loss is fixed for each pair of nodes and doesn't depend on their actual positions.
  13.115   * 
  13.116   * This is supposed to be used by synthetic tests. Note that by default propagation loss is assumed to be symmetric.
  13.117 @@ -520,6 +539,8 @@
  13.118  };
  13.119  
  13.120  /**
  13.121 + * \ingroup propagation
  13.122 + *
  13.123   * \brief The propagation loss depends only on the distance (range) between transmitter and receiver.
  13.124   *
  13.125   * The single MaxRange attribute (units of meters) determines path loss.
    14.1 --- a/src/spectrum/helper/adhoc-aloha-noack-ideal-phy-helper.h	Wed May 18 20:01:44 2011 -0400
    14.2 +++ b/src/spectrum/helper/adhoc-aloha-noack-ideal-phy-helper.h	Wed May 18 17:24:04 2011 -0700
    14.3 @@ -36,6 +36,8 @@
    14.4  class SpectrumChannel;
    14.5  
    14.6  /**
    14.7 + * \ingroup spectrum
    14.8 + *
    14.9   *
   14.10   * create the NetDevice depicted in the figure
   14.11   * @image html HdOfdmAlohaNoAck.png
    15.1 --- a/src/spectrum/helper/spectrum-analyzer-helper.h	Wed May 18 20:01:44 2011 -0400
    15.2 +++ b/src/spectrum/helper/spectrum-analyzer-helper.h	Wed May 18 17:24:04 2011 -0700
    15.3 @@ -37,6 +37,10 @@
    15.4  class SpectrumChannel;
    15.5  class SpectrumModel;
    15.6  
    15.7 +/**
    15.8 + * \ingroup spectrum
    15.9 + *
   15.10 + */
   15.11  class SpectrumAnalyzerHelper
   15.12  {
   15.13  public:
    16.1 --- a/src/spectrum/helper/spectrum-helper.h	Wed May 18 20:01:44 2011 -0400
    16.2 +++ b/src/spectrum/helper/spectrum-helper.h	Wed May 18 17:24:04 2011 -0700
    16.3 @@ -35,6 +35,10 @@
    16.4  class NetDevice;
    16.5  
    16.6  
    16.7 +/**
    16.8 + * \ingroup spectrum
    16.9 + *
   16.10 + */
   16.11  class SpectrumChannelHelper
   16.12  {
   16.13  public:
   16.14 @@ -146,6 +150,8 @@
   16.15  
   16.16  
   16.17  /**
   16.18 + * \ingroup spectrum
   16.19 + *
   16.20   * create and configure several SpectrumPhy instances and connect them to a channel.
   16.21   */
   16.22  class SpectrumPhyHelper
    17.1 --- a/src/spectrum/helper/waveform-generator-helper.h	Wed May 18 20:01:44 2011 -0400
    17.2 +++ b/src/spectrum/helper/waveform-generator-helper.h	Wed May 18 17:24:04 2011 -0700
    17.3 @@ -37,6 +37,10 @@
    17.4  class SpectrumChannel;
    17.5  
    17.6  
    17.7 +/**
    17.8 + * \ingroup spectrum
    17.9 + *
   17.10 + */
   17.11  class WaveformGeneratorHelper
   17.12  {
   17.13  public:
    18.1 --- a/src/spectrum/model/aloha-noack-mac-header.h	Wed May 18 20:01:44 2011 -0400
    18.2 +++ b/src/spectrum/model/aloha-noack-mac-header.h	Wed May 18 17:24:04 2011 -0700
    18.3 @@ -28,6 +28,10 @@
    18.4  
    18.5  namespace ns3 {
    18.6  
    18.7 +/**
    18.8 + * \ingroup spectrum
    18.9 + *
   18.10 + */
   18.11  class AlohaNoackMacHeader : public Header
   18.12  {
   18.13  public:
    19.1 --- a/src/spectrum/model/aloha-noack-net-device.h	Wed May 18 20:01:44 2011 -0400
    19.2 +++ b/src/spectrum/model/aloha-noack-net-device.h	Wed May 18 17:24:04 2011 -0700
    19.3 @@ -44,6 +44,8 @@
    19.4  
    19.5  
    19.6  /**
    19.7 + * \ingroup spectrum
    19.8 + *
    19.9   * This devices implements the following features:
   19.10   *  - layer 3 protocol multiplexing
   19.11   *  - MAC addressing
    20.1 --- a/src/spectrum/model/friis-spectrum-propagation-loss.h	Wed May 18 20:01:44 2011 -0400
    20.2 +++ b/src/spectrum/model/friis-spectrum-propagation-loss.h	Wed May 18 17:24:04 2011 -0700
    20.3 @@ -30,6 +30,10 @@
    20.4  class MobilityModel;
    20.5  
    20.6  
    20.7 +/**
    20.8 + * \ingroup spectrum
    20.9 + *
   20.10 + */
   20.11  class FriisSpectrumPropagationLossModel : public SpectrumPropagationLossModel
   20.12  {
   20.13  
    21.1 --- a/src/spectrum/model/half-duplex-ideal-phy.h	Wed May 18 20:01:44 2011 -0400
    21.2 +++ b/src/spectrum/model/half-duplex-ideal-phy.h	Wed May 18 17:24:04 2011 -0700
    21.3 @@ -40,6 +40,8 @@
    21.4  
    21.5  
    21.6  /**
    21.7 + * \ingroup spectrum
    21.8 + *
    21.9   * This PHY layer implementation realizes an ideal OFDM PHY which
   21.10   * transmits half-duplex (i.e., it can either receive or transmit at a
   21.11   * given time). The device is ideal in the sense that:
    22.1 --- a/src/spectrum/model/microwave-oven-spectrum-value-helper.h	Wed May 18 20:01:44 2011 -0400
    22.2 +++ b/src/spectrum/model/microwave-oven-spectrum-value-helper.h	Wed May 18 17:24:04 2011 -0700
    22.3 @@ -29,6 +29,8 @@
    22.4  
    22.5  
    22.6  /**
    22.7 + * \ingroup spectrum
    22.8 + *
    22.9   * This class provides methods for the creation of SpectrumValue
   22.10   * instances that mimic the Power Spectral Density of commercial
   22.11   * microwave ovens based on the measurements reported in the following paper:
    23.1 --- a/src/spectrum/model/multi-model-spectrum-channel.h	Wed May 18 20:01:44 2011 -0400
    23.2 +++ b/src/spectrum/model/multi-model-spectrum-channel.h	Wed May 18 17:24:04 2011 -0700
    23.3 @@ -36,6 +36,10 @@
    23.4  typedef std::map<SpectrumModelUid_t, SpectrumConverter> SpectrumConverterMap_t;
    23.5  
    23.6  
    23.7 +/**
    23.8 + * \ingroup spectrum
    23.9 + *
   23.10 + */
   23.11  class TxSpectrumModelInfo
   23.12  {
   23.13  public:
   23.14 @@ -48,6 +52,10 @@
   23.15  typedef std::map<SpectrumModelUid_t, TxSpectrumModelInfo> TxSpectrumModelInfoMap_t;
   23.16  
   23.17  
   23.18 +/**
   23.19 + * \ingroup spectrum
   23.20 + *
   23.21 + */
   23.22  class RxSpectrumModelInfo
   23.23  {
   23.24  public:
   23.25 @@ -63,6 +71,8 @@
   23.26  
   23.27  
   23.28  /**
   23.29 + * \ingroup spectrum
   23.30 + *
   23.31   * This SpectrumChannel implementation can handle the presence of
   23.32   * SpectrumPhy instances which can use
   23.33   * different spectrum models, i.e.,  different SpectrumModel. The only
    24.1 --- a/src/spectrum/model/non-communicating-net-device.h	Wed May 18 20:01:44 2011 -0400
    24.2 +++ b/src/spectrum/model/non-communicating-net-device.h	Wed May 18 17:24:04 2011 -0700
    24.3 @@ -41,6 +41,8 @@
    24.4  
    24.5  
    24.6  /**
    24.7 + * \ingroup spectrum
    24.8 + *
    24.9   * This class implements a device which does not communicate, in the
   24.10   * sense that it does not interact with the above protocol stack. The
   24.11   * purpose of this NetDevice is to be used for devices such as
    25.1 --- a/src/spectrum/model/single-model-spectrum-channel.h	Wed May 18 20:01:44 2011 -0400
    25.2 +++ b/src/spectrum/model/single-model-spectrum-channel.h	Wed May 18 17:24:04 2011 -0700
    25.3 @@ -31,6 +31,8 @@
    25.4  
    25.5  
    25.6  /**
    25.7 + * \ingroup spectrum
    25.8 + *
    25.9   * @brief SpectrumChannel implementation which handles a single spectrum model
   25.10   *
   25.11   * All SpectrumPhy layers attached to this SpectrumChannel
    26.1 --- a/src/spectrum/model/spectrum-analyzer.h	Wed May 18 20:01:44 2011 -0400
    26.2 +++ b/src/spectrum/model/spectrum-analyzer.h	Wed May 18 17:24:04 2011 -0700
    26.3 @@ -36,6 +36,8 @@
    26.4  
    26.5  
    26.6  /**
    26.7 + * \ingroup spectrum
    26.8 + *
    26.9   * Simple SpectrumPhy implemetation that averages the spectrum power
   26.10   * density of incoming transmissions to produce a spectrogram.
   26.11   *
    27.1 --- a/src/spectrum/model/spectrum-channel.h	Wed May 18 20:01:44 2011 -0400
    27.2 +++ b/src/spectrum/model/spectrum-channel.h	Wed May 18 17:24:04 2011 -0700
    27.3 @@ -37,6 +37,8 @@
    27.4  class PropagationDelayModel;
    27.5  
    27.6  /**
    27.7 + * \ingroup spectrum
    27.8 + *
    27.9   * Defines the interface for spectrum-aware channel implementations
   27.10   *
   27.11   */
    28.1 --- a/src/spectrum/model/spectrum-converter.h	Wed May 18 20:01:44 2011 -0400
    28.2 +++ b/src/spectrum/model/spectrum-converter.h	Wed May 18 17:24:04 2011 -0700
    28.3 @@ -27,6 +27,8 @@
    28.4  namespace ns3 {
    28.5  
    28.6  /**
    28.7 + * \ingroup spectrum
    28.8 + *
    28.9   * Class which implements a converter between SpectrumValue which are
   28.10   * defined over different SpectrumModel. In more formal terms, this class
   28.11   * allows conversion between different function spaces. In practical
    29.1 --- a/src/spectrum/model/spectrum-error-model.h	Wed May 18 20:01:44 2011 -0400
    29.2 +++ b/src/spectrum/model/spectrum-error-model.h	Wed May 18 17:24:04 2011 -0700
    29.3 @@ -32,6 +32,10 @@
    29.4  
    29.5  
    29.6  
    29.7 +/**
    29.8 + * \ingroup spectrum
    29.9 + *
   29.10 + */
   29.11  class SpectrumErrorModel :  public Object
   29.12  {
   29.13  public:
   29.14 @@ -43,6 +47,8 @@
   29.15  
   29.16  
   29.17  /**
   29.18 + * \ingroup spectrum
   29.19 + *
   29.20   * This class implements the error model described in this paper:
   29.21   * N. Baldo and M. Miozzo, "Spectrum-aware Channel and PHY layer modeling
   29.22   * for ns3", in Proceedings of International Workshop on Network
    30.1 --- a/src/spectrum/model/spectrum-interference.h	Wed May 18 20:01:44 2011 -0400
    30.2 +++ b/src/spectrum/model/spectrum-interference.h	Wed May 18 17:24:04 2011 -0700
    30.3 @@ -37,6 +37,8 @@
    30.4  
    30.5  
    30.6  /**
    30.7 + * \ingroup spectrum
    30.8 + *
    30.9   * This class implements a gaussian interference model, i.e., all
   30.10   * incoming signals are added to the total interference.
   30.11   *
    31.1 --- a/src/spectrum/model/spectrum-model.h	Wed May 18 20:01:44 2011 -0400
    31.2 +++ b/src/spectrum/model/spectrum-model.h	Wed May 18 17:24:04 2011 -0700
    31.3 @@ -26,9 +26,14 @@
    31.4  
    31.5  namespace ns3 {
    31.6  
    31.7 -
    31.8 +/**
    31.9 + * \defgroup spectrum Spectrum Models
   31.10 + *
   31.11 + */
   31.12  
   31.13  /**
   31.14 + * \ingroup spectrum
   31.15 + *
   31.16   * The building block of a SpectrumModel. This struct models
   31.17   * a frequency band defined by the frequency interval [fl, fc] and
   31.18   * with center frequency fc. Typically, the center frequency will be
    32.1 --- a/src/spectrum/model/spectrum-phy.h	Wed May 18 20:01:44 2011 -0400
    32.2 +++ b/src/spectrum/model/spectrum-phy.h	Wed May 18 17:24:04 2011 -0700
    32.3 @@ -36,6 +36,8 @@
    32.4  class NetDevice;
    32.5  
    32.6  /**
    32.7 + * \ingroup spectrum
    32.8 + *
    32.9   * Abstract base class for Spectrum-aware PHY layers
   32.10   *
   32.11   */
    33.1 --- a/src/spectrum/model/spectrum-propagation-loss-model.h	Wed May 18 20:01:44 2011 -0400
    33.2 +++ b/src/spectrum/model/spectrum-propagation-loss-model.h	Wed May 18 17:24:04 2011 -0700
    33.3 @@ -32,6 +32,8 @@
    33.4  
    33.5  
    33.6  /**
    33.7 + * \ingroup spectrum
    33.8 + *
    33.9   * \brief spectrum-aware propagation loss model
   33.10   *
   33.11   * Interface for propagation loss models to be adopted when
    34.1 --- a/src/spectrum/model/spectrum-type.h	Wed May 18 20:01:44 2011 -0400
    34.2 +++ b/src/spectrum/model/spectrum-type.h	Wed May 18 17:24:04 2011 -0700
    34.3 @@ -31,6 +31,8 @@
    34.4  
    34.5  
    34.6  /**
    34.7 + * \ingroup spectrum
    34.8 + *
    34.9   * This class represent a type of signal that can be transmitted by
   34.10   * SpectrumPhy instances over a SpectrumChannel. By means of this
   34.11   * class a SpectrumPhy is able to recognize which type of signals it
   34.12 @@ -62,6 +64,10 @@
   34.13  
   34.14  
   34.15  
   34.16 +/**
   34.17 + * \ingroup spectrum
   34.18 + *
   34.19 + */
   34.20  class SpectrumTypeFactory
   34.21  {
   34.22  
    35.1 --- a/src/spectrum/model/spectrum-value.h	Wed May 18 20:01:44 2011 -0400
    35.2 +++ b/src/spectrum/model/spectrum-value.h	Wed May 18 17:24:04 2011 -0700
    35.3 @@ -33,6 +33,8 @@
    35.4  typedef std::vector<double> Values;
    35.5  
    35.6  /**
    35.7 + * \ingroup spectrum
    35.8 + *
    35.9   * \brief Set of values corresponding to a given SpectrumModel
   35.10   *
   35.11   * This class implements a Function Space which can represent any
    36.1 --- a/src/spectrum/model/waveform-generator.h	Wed May 18 20:01:44 2011 -0400
    36.2 +++ b/src/spectrum/model/waveform-generator.h	Wed May 18 17:24:04 2011 -0700
    36.3 @@ -37,6 +37,8 @@
    36.4  
    36.5  
    36.6  /**
    36.7 + * \ingroup spectrum
    36.8 + *
    36.9   * Simple SpectrumPhy implementation that sends customizable waveform.
   36.10   * The generated waveforms have a given Spectrum Power Density and
   36.11   * duration (set with the SetResolution()) . The generator activates
    37.1 --- a/src/spectrum/model/wifi-spectrum-value-helper.h	Wed May 18 20:01:44 2011 -0400
    37.2 +++ b/src/spectrum/model/wifi-spectrum-value-helper.h	Wed May 18 17:24:04 2011 -0700
    37.3 @@ -29,6 +29,8 @@
    37.4  
    37.5  
    37.6  /**
    37.7 + * \ingroup spectrum
    37.8 + *
    37.9   * this abstract class defines the interface for interacting with all WifiSpectrumValue implementations.
   37.10   *
   37.11   */
   37.12 @@ -71,6 +73,8 @@
   37.13  
   37.14  
   37.15  /**
   37.16 + * \ingroup spectrum
   37.17 + *
   37.18   * Implements WifiSpectrumValue for the 2.4 GHz ISM band only, with a
   37.19   * 5 MHz spectrum resolution.
   37.20   *
    38.1 --- a/src/stats/model/basic-data-calculators.h	Wed May 18 20:01:44 2011 -0400
    38.2 +++ b/src/stats/model/basic-data-calculators.h	Wed May 18 17:24:04 2011 -0700
    38.3 @@ -26,6 +26,11 @@
    38.4  
    38.5  namespace ns3 {
    38.6  
    38.7 +/**
    38.8 + * \defgroup stats Statistics
    38.9 + *
   38.10 + */
   38.11 +
   38.12  //------------------------------------------------------------
   38.13  //--------------------------------------------
   38.14  template <typename T  = uint32_t>
   38.15 @@ -105,6 +110,10 @@
   38.16  }
   38.17  
   38.18  
   38.19 +/**
   38.20 + * \ingroup stats
   38.21 + *
   38.22 + */
   38.23  //------------------------------------------------------------
   38.24  //--------------------------------------------
   38.25  template <typename T  = uint32_t>
    39.1 --- a/src/stats/model/data-collector.h	Wed May 18 20:01:44 2011 -0400
    39.2 +++ b/src/stats/model/data-collector.h	Wed May 18 17:24:04 2011 -0700
    39.3 @@ -28,6 +28,10 @@
    39.4  
    39.5  namespace ns3 {
    39.6  
    39.7 +/**
    39.8 + * \ingroup stats
    39.9 + *
   39.10 + */
   39.11  class DataCalculator;
   39.12  
   39.13  //------------------------------------------------------------
   39.14 @@ -35,6 +39,10 @@
   39.15  typedef std::list<Ptr<DataCalculator> > DataCalculatorList;
   39.16  typedef std::list<std::pair<std::string, std::string> > MetadataList;
   39.17  
   39.18 +/**
   39.19 + * \ingroup stats
   39.20 + *
   39.21 + */
   39.22  class DataCollector : public Object {
   39.23  public:
   39.24    DataCollector();
    40.1 --- a/src/stats/model/data-output-interface.h	Wed May 18 20:01:44 2011 -0400
    40.2 +++ b/src/stats/model/data-output-interface.h	Wed May 18 17:24:04 2011 -0700
    40.3 @@ -31,6 +31,10 @@
    40.4  
    40.5  //------------------------------------------------------------
    40.6  //--------------------------------------------
    40.7 +/**
    40.8 + * \ingroup stats
    40.9 + *
   40.10 + */
   40.11  class DataOutputInterface : public Object {
   40.12  public:
   40.13    DataOutputInterface();
   40.14 @@ -49,6 +53,10 @@
   40.15    // end class DataOutputInterface
   40.16  };
   40.17  
   40.18 +/**
   40.19 + * \ingroup stats
   40.20 + *
   40.21 + */
   40.22  class DataOutputCallback {
   40.23  public:
   40.24    virtual ~DataOutputCallback() {}
    41.1 --- a/src/stats/model/omnet-data-output.h	Wed May 18 20:01:44 2011 -0400
    41.2 +++ b/src/stats/model/omnet-data-output.h	Wed May 18 17:24:04 2011 -0700
    41.3 @@ -30,6 +30,10 @@
    41.4  
    41.5  //------------------------------------------------------------
    41.6  //--------------------------------------------
    41.7 +/**
    41.8 + * \ingroup stats
    41.9 + *
   41.10 + */
   41.11  class OmnetDataOutput : public DataOutputInterface {
   41.12  public:
   41.13    OmnetDataOutput();
    42.1 --- a/src/stats/model/packet-data-calculators.h	Wed May 18 20:01:44 2011 -0400
    42.2 +++ b/src/stats/model/packet-data-calculators.h	Wed May 18 17:24:04 2011 -0700
    42.3 @@ -28,6 +28,10 @@
    42.4  
    42.5  namespace ns3 {
    42.6  
    42.7 +/**
    42.8 + * \ingroup stats
    42.9 + *
   42.10 + */
   42.11  class PacketCounterCalculator : public CounterCalculator<uint32_t> {
   42.12  public:
   42.13    PacketCounterCalculator();
   42.14 @@ -44,6 +48,10 @@
   42.15  };
   42.16  
   42.17  
   42.18 +/**
   42.19 + * \ingroup stats
   42.20 + *
   42.21 + */
   42.22  class PacketSizeMinMaxAvgTotalCalculator :
   42.23    public MinMaxAvgTotalCalculator<uint32_t> {
   42.24  public:
    43.1 --- a/src/stats/model/sqlite-data-output.h	Wed May 18 20:01:44 2011 -0400
    43.2 +++ b/src/stats/model/sqlite-data-output.h	Wed May 18 17:24:04 2011 -0700
    43.3 @@ -33,6 +33,10 @@
    43.4  
    43.5  //------------------------------------------------------------
    43.6  //--------------------------------------------
    43.7 +/**
    43.8 + * \ingroup stats
    43.9 + *
   43.10 + */
   43.11  class SqliteDataOutput : public DataOutputInterface {
   43.12  public:
   43.13    SqliteDataOutput();
    44.1 --- a/src/stats/model/time-data-calculators.h	Wed May 18 20:01:44 2011 -0400
    44.2 +++ b/src/stats/model/time-data-calculators.h	Wed May 18 17:24:04 2011 -0700
    44.3 @@ -31,6 +31,8 @@
    44.4  //------------------------------------------------------------
    44.5  //--------------------------------------------
    44.6  /**
    44.7 + * \ingroup stats
    44.8 + *
    44.9   * Unfortunately, templating the base MinMaxAvgTotalCalculator to
   44.10   * operate over Time values isn't straightforward.  The main issues
   44.11   * are setting the maximum value, which can be worked around easily
    45.1 --- a/src/tools/model/average.h	Wed May 18 20:01:44 2011 -0400
    45.2 +++ b/src/tools/model/average.h	Wed May 18 17:24:04 2011 -0700
    45.3 @@ -28,7 +28,18 @@
    45.4  
    45.5  namespace ns3 {
    45.6  
    45.7 -/// Simple average, min, max and std. deviation calculator
    45.8 +/**
    45.9 + * \defgroup tools Tools
   45.10 + *
   45.11 + */
   45.12 +
   45.13 +/**
   45.14 + * \ingroup tools
   45.15 + *
   45.16 + * Simple average, min, max and std. deviation calculator
   45.17 + *
   45.18 + */
   45.19 +
   45.20  template <typename T = double>
   45.21  class Average
   45.22  {
    46.1 --- a/src/tools/model/delay-jitter-estimation.h	Wed May 18 20:01:44 2011 -0400
    46.2 +++ b/src/tools/model/delay-jitter-estimation.h	Wed May 18 17:24:04 2011 -0700
    46.3 @@ -7,6 +7,8 @@
    46.4  namespace ns3 {
    46.5  
    46.6  /**
    46.7 + * \ingroup tools
    46.8 + *
    46.9   * \brief quick and dirty delay and jitter estimation
   46.10   *
   46.11   */
    47.1 --- a/src/tools/model/event-garbage-collector.h	Wed May 18 20:01:44 2011 -0400
    47.2 +++ b/src/tools/model/event-garbage-collector.h	Wed May 18 17:24:04 2011 -0700
    47.3 @@ -27,6 +27,8 @@
    47.4  namespace ns3 {
    47.5  
    47.6  /**
    47.7 + * \ingroup tools
    47.8 + *
    47.9   * \brief An object that tracks scheduled events and automatically
   47.10   * cancels them when it is destroyed.  It is useful in situations
   47.11   * where multiple instances of the same type of event can
    48.1 --- a/src/tools/model/gnuplot.h	Wed May 18 20:01:44 2011 -0400
    48.2 +++ b/src/tools/model/gnuplot.h	Wed May 18 17:24:04 2011 -0700
    48.3 @@ -28,6 +28,8 @@
    48.4  namespace ns3 {
    48.5  
    48.6  /**
    48.7 + * \ingroup tools
    48.8 + *
    48.9   * \brief Abstract class to store a plot line to be used by ns3::Gnuplot.
   48.10   *
   48.11   * This class contains a reference counted data object in m_data. The data
    49.1 --- a/src/virtual-net-device/model/virtual-net-device.h	Wed May 18 20:01:44 2011 -0400
    49.2 +++ b/src/virtual-net-device/model/virtual-net-device.h	Wed May 18 17:24:04 2011 -0700
    49.3 @@ -33,6 +33,13 @@
    49.4  
    49.5  
    49.6  /**
    49.7 + * \defgroup virtualdevice Virtual Device
    49.8 + *
    49.9 + */
   49.10 +
   49.11 +/**
   49.12 + * \ingroup virtualdevice
   49.13 + *
   49.14   * \class VirtualNetDevice
   49.15   * \brief A virtual device, similar to Linux TUN/TAP interfaces.
   49.16   *
    50.1 --- a/src/visualizer/model/pyviz.h	Wed May 18 20:01:44 2011 -0400
    50.2 +++ b/src/visualizer/model/pyviz.h	Wed May 18 17:24:04 2011 -0700
    50.3 @@ -38,6 +38,8 @@
    50.4  namespace ns3 {
    50.5  
    50.6  /**
    50.7 + * \ingroup visualizer
    50.8 + *
    50.9   * \brief helper class to be used by the visualizer
   50.10   * \internal
   50.11   *
    51.1 --- a/src/visualizer/model/visual-simulator-impl.h	Wed May 18 20:01:44 2011 -0400
    51.2 +++ b/src/visualizer/model/visual-simulator-impl.h	Wed May 18 17:24:04 2011 -0700
    51.3 @@ -27,6 +27,13 @@
    51.4  
    51.5  
    51.6  /**
    51.7 + * \defgroup  visualizer Visualizer
    51.8 + *
    51.9 + */
   51.10 +
   51.11 +/**
   51.12 + * \ingroup visualizer
   51.13 + *
   51.14   * \brief A replacement simulator that starts the visualizer
   51.15   * \internal
   51.16   *