bug 202: classes disappeared from doxygen output
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Wed Jun 04 11:48:52 2008 -0700 (20 months ago)
changeset 3222f61c17b62fd1
parent 3221 bd02183f788b
child 3223 87b3ea3ae0f8
bug 202: classes disappeared from doxygen output
src/common/data-rate.h
src/common/error-model.h
src/common/packet.h
src/internet-node/tcp-socket-factory-impl.h
src/node/application.h
src/node/channel.h
src/node/net-device.h
src/node/queue.h
src/node/socket.h
src/simulator/nstime.h
src/simulator/scheduler.h
     1.1 --- a/src/common/data-rate.h	Wed Jun 04 11:35:14 2008 -0700
     1.2 +++ b/src/common/data-rate.h	Wed Jun 04 11:48:52 2008 -0700
     1.3 @@ -33,7 +33,9 @@
     1.4  /**
     1.5   * \ingroup common
     1.6   * \defgroup datarate Data Rate
     1.7 - *
     1.8 + */
     1.9 +/**
    1.10 + * \ingroup datarate
    1.11   * \brief Class for representing data rates
    1.12   *
    1.13   * Allows for natural and familiar use of data rates.  Allows construction
     2.1 --- a/src/common/error-model.h	Wed Jun 04 11:35:14 2008 -0700
     2.2 +++ b/src/common/error-model.h	Wed Jun 04 11:48:52 2008 -0700
     2.3 @@ -32,7 +32,9 @@
     2.4  /**
     2.5   * \ingroup common
     2.6   * \defgroup errormodel Error Model
     2.7 - *
     2.8 + */
     2.9 +/**
    2.10 + * \ingroup errormodel
    2.11   * \brief General error model that can be used to corrupt packets
    2.12   *
    2.13   * This object is used to flag packets as being lost/errored or not.
     3.1 --- a/src/common/packet.h	Wed Jun 04 11:35:14 2008 -0700
     3.2 +++ b/src/common/packet.h	Wed Jun 04 11:48:52 2008 -0700
     3.3 @@ -34,6 +34,12 @@
     3.4  namespace ns3 {
     3.5  
     3.6  /**
     3.7 + * \ingroup common
     3.8 + * \defgroup packet Packet
     3.9 + */
    3.10 +
    3.11 +/**
    3.12 + * \ingroup packet
    3.13   * \brief Iterator over the set of tags in a packet
    3.14   *
    3.15   * This is a java-style iterator.
    3.16 @@ -96,9 +102,7 @@
    3.17  };
    3.18  
    3.19  /**
    3.20 - * \ingroup common
    3.21 - * \defgroup packet Packet
    3.22 - *
    3.23 + * \ingroup packet
    3.24   * \brief network packets
    3.25   *
    3.26   * Each network packet contains a byte buffer, a set of tags, and
     4.1 --- a/src/internet-node/tcp-socket-factory-impl.h	Wed Jun 04 11:35:14 2008 -0700
     4.2 +++ b/src/internet-node/tcp-socket-factory-impl.h	Wed Jun 04 11:48:52 2008 -0700
     4.3 @@ -30,7 +30,9 @@
     4.4  /**
     4.5   * \ingroup internetNode
     4.6   * \defgroup Tcp Tcp
     4.7 - *
     4.8 + */
     4.9 +/**
    4.10 + * \ingroup Tcp
    4.11   * \section Tcp Overview
    4.12   *
    4.13   * The TCP code in ns3::InternetNode is ported from the  
     5.1 --- a/src/node/application.h	Wed Jun 04 11:35:14 2008 -0700
     5.2 +++ b/src/node/application.h	Wed Jun 04 11:48:52 2008 -0700
     5.3 @@ -35,8 +35,10 @@
     5.4  /**
     5.5   * \ingroup node
     5.6   * \defgroup application Application
     5.7 - *
     5.8 - * \brief The base class for all ns3 applicationes
     5.9 + */
    5.10 +/**
    5.11 + * \ingroup application
    5.12 + * \brief The base class for all ns3 applications
    5.13   * 
    5.14   * Class Application is the base class for all ns3 applications.
    5.15   * Applications are associated with individual nodes.
     6.1 --- a/src/node/channel.h	Wed Jun 04 11:35:14 2008 -0700
     6.2 +++ b/src/node/channel.h	Wed Jun 04 11:48:52 2008 -0700
     6.3 @@ -29,7 +29,9 @@
     6.4  /**
     6.5   * \ingroup node
     6.6   * \defgroup channel Channel
     6.7 - *
     6.8 + */
     6.9 +/**
    6.10 + * \ingroup channel
    6.11   * \brief Abstract Channel Base Class.
    6.12   *
    6.13   * A channel is a logical path over which information flows.  The path can
     7.1 --- a/src/node/net-device.h	Wed Jun 04 11:35:14 2008 -0700
     7.2 +++ b/src/node/net-device.h	Wed Jun 04 11:48:52 2008 -0700
     7.3 @@ -40,7 +40,7 @@
     7.4   * \defgroup netdevice NetDevice
     7.5   */
     7.6  /**
     7.7 - * \ingroup NetDevice
     7.8 + * \ingroup netdevice
     7.9   *
    7.10   * \brief Network layer to device interface
    7.11   *
     8.1 --- a/src/node/queue.h	Wed Jun 04 11:35:14 2008 -0700
     8.2 +++ b/src/node/queue.h	Wed Jun 04 11:48:52 2008 -0700
     8.3 @@ -35,7 +35,9 @@
     8.4  /**
     8.5   * \ingroup node
     8.6   * \defgroup queue Queue
     8.7 - *
     8.8 + */
     8.9 +/**
    8.10 + * \ingroup queue
    8.11   * \brief Abstract base class for packet Queues
    8.12   * 
    8.13   * This class defines the base APIs for packet queues in the ns-3 system
     9.1 --- a/src/node/socket.h	Wed Jun 04 11:35:14 2008 -0700
     9.2 +++ b/src/node/socket.h	Wed Jun 04 11:48:52 2008 -0700
     9.3 @@ -39,7 +39,11 @@
     9.4  /**
     9.5   * \ingroup node
     9.6   * \defgroup socket Socket
     9.7 + */
     9.8 +
     9.9 +/**
    9.10   * \brief A low-level Socket API based loosely on the BSD Socket API.
    9.11 + * \ingroup socket
    9.12   *
    9.13   * A few things to keep in mind about this type of socket:
    9.14   * - it uses ns-3 API constructs such as class ns3::Address instead of
    10.1 --- a/src/simulator/nstime.h	Wed Jun 04 11:35:14 2008 -0700
    10.2 +++ b/src/simulator/nstime.h	Wed Jun 04 11:48:52 2008 -0700
    10.3 @@ -62,7 +62,9 @@
    10.4  /**
    10.5   * \ingroup simulator
    10.6   * \defgroup time Time
    10.7 - *
    10.8 + */
    10.9 +/**
   10.10 + * \ingroup time
   10.11   * \brief keep track of time unit.
   10.12   *
   10.13   * This template class is used to keep track of the value 
    11.1 --- a/src/simulator/scheduler.h	Wed Jun 04 11:35:14 2008 -0700
    11.2 +++ b/src/simulator/scheduler.h	Wed Jun 04 11:48:52 2008 -0700
    11.3 @@ -30,7 +30,9 @@
    11.4  /**
    11.5   * \ingroup simulator
    11.6   * \defgroup scheduler Scheduler
    11.7 - *
    11.8 + */
    11.9 +/**
   11.10 + * \ingroup scheduler
   11.11   * \brief Maintain the event list
   11.12   *
   11.13   * This base class specifies the interface used to maintain the