Some doxygen work
authorTom Henderson <tomh@tomh.org>
Thu Apr 03 09:07:15 2008 -0700 (22 months ago)
changeset 2867d63b525e3f80
parent 2865 d40eb18a4da0
child 2868 1102aaae54b8
Some doxygen work
doc/modules
src/core/attribute-helper.h
src/devices/csma/csma.h
src/devices/point-to-point/point-to-point.h
src/internet-node/tcp-impl.h
     1.1 --- a/doc/modules	Wed Apr 02 21:33:31 2008 -0700
     1.2 +++ b/doc/modules	Thu Apr 03 09:07:15 2008 -0700
     1.3 @@ -41,9 +41,6 @@
     1.4   * 
     1.5   *
     1.6   * @defgroup devices Devices
     1.7 - * The "devices" module contains:
     1.8 - *    - a PointToPoint MAC device: ns3::PointToPointNetDevice, ns3::PointToPointChannel,
     1.9 - *      and ns3::PointToPointTopology.
    1.10   *
    1.11   * @defgroup internetNode InternetNode
    1.12   * 
    1.13 @@ -53,6 +50,8 @@
    1.14   *    - an ARP module
    1.15   *    - an InternetNode class which is a Node subclass.
    1.16   *    
    1.17 + * @defgroup helper Helpers
    1.18 + * 
    1.19   * @defgroup applications Applications
    1.20   *
    1.21   * @defgroup mobility Mobility
     2.1 --- a/src/core/attribute-helper.h	Wed Apr 02 21:33:31 2008 -0700
     2.2 +++ b/src/core/attribute-helper.h	Thu Apr 03 09:07:15 2008 -0700
     2.3 @@ -57,6 +57,7 @@
     2.4  }
     2.5  
     2.6  /**
     2.7 + * \ingroup core
     2.8   * \defgroup AttributeHelper Attribute Helper
     2.9   *
    2.10   * All these macros can be used to generate automatically the code
     3.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     3.2 +++ b/src/devices/csma/csma.h	Thu Apr 03 09:07:15 2008 -0700
     3.3 @@ -0,0 +1,9 @@
     3.4 +/**
     3.5 + * \ingroup devices
     3.6 + * \defgroup Csma Csma Models
     3.7 + *
     3.8 + * \section Csma Models
     3.9 + *
    3.10 + * The set of Csma models provides an abstrated shared media net device
    3.11 + * and channel, similar to a switched ethernet.
    3.12 + */
     4.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     4.2 +++ b/src/devices/point-to-point/point-to-point.h	Thu Apr 03 09:07:15 2008 -0700
     4.3 @@ -0,0 +1,11 @@
     4.4 +/**
     4.5 + * \ingroup devices
     4.6 + * \defgroup PointToPoint Point-to-Point Models
     4.7 + *
     4.8 + * \section Point-to-Point Models
     4.9 + *
    4.10 + * The set of Point-to-Point models provides an abstrated point-to-point link
    4.11 + * model, that simulates transmission delay (finite data rate) and 
    4.12 + * propagation delay, and can also optionally include an error model
    4.13 + * (ns3::ErrorModel).
    4.14 + */
     5.1 --- a/src/internet-node/tcp-impl.h	Wed Apr 02 21:33:31 2008 -0700
     5.2 +++ b/src/internet-node/tcp-impl.h	Thu Apr 03 09:07:15 2008 -0700
     5.3 @@ -28,7 +28,7 @@
     5.4  class TcpL4Protocol;
     5.5  
     5.6  /**
     5.7 - * \ingroup InternetNode
     5.8 + * \ingroup internetNode
     5.9   * \defgroup Tcp Tcp
    5.10   *
    5.11   * \section Tcp Overview