Some doxygen work
authorTom Henderson <tomh@tomh.org>
Thu, 03 Apr 2008 09:07:15 -0700
changeset 2867 d63b525e3f80
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
--- a/doc/modules	Wed Apr 02 21:33:31 2008 -0700
+++ b/doc/modules	Thu Apr 03 09:07:15 2008 -0700
@@ -41,9 +41,6 @@
  * 
  *
  * @defgroup devices Devices
- * The "devices" module contains:
- *    - a PointToPoint MAC device: ns3::PointToPointNetDevice, ns3::PointToPointChannel,
- *      and ns3::PointToPointTopology.
  *
  * @defgroup internetNode InternetNode
  * 
@@ -53,6 +50,8 @@
  *    - an ARP module
  *    - an InternetNode class which is a Node subclass.
  *    
+ * @defgroup helper Helpers
+ * 
  * @defgroup applications Applications
  *
  * @defgroup mobility Mobility
--- a/src/core/attribute-helper.h	Wed Apr 02 21:33:31 2008 -0700
+++ b/src/core/attribute-helper.h	Thu Apr 03 09:07:15 2008 -0700
@@ -57,6 +57,7 @@
 }
 
 /**
+ * \ingroup core
  * \defgroup AttributeHelper Attribute Helper
  *
  * All these macros can be used to generate automatically the code
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/devices/csma/csma.h	Thu Apr 03 09:07:15 2008 -0700
@@ -0,0 +1,9 @@
+/**
+ * \ingroup devices
+ * \defgroup Csma Csma Models
+ *
+ * \section Csma Models
+ *
+ * The set of Csma models provides an abstrated shared media net device
+ * and channel, similar to a switched ethernet.
+ */
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/devices/point-to-point/point-to-point.h	Thu Apr 03 09:07:15 2008 -0700
@@ -0,0 +1,11 @@
+/**
+ * \ingroup devices
+ * \defgroup PointToPoint Point-to-Point Models
+ *
+ * \section Point-to-Point Models
+ *
+ * The set of Point-to-Point models provides an abstrated point-to-point link
+ * model, that simulates transmission delay (finite data rate) and 
+ * propagation delay, and can also optionally include an error model
+ * (ns3::ErrorModel).
+ */
--- a/src/internet-node/tcp-impl.h	Wed Apr 02 21:33:31 2008 -0700
+++ b/src/internet-node/tcp-impl.h	Thu Apr 03 09:07:15 2008 -0700
@@ -28,7 +28,7 @@
 class TcpL4Protocol;
 
 /**
- * \ingroup InternetNode
+ * \ingroup internetNode
  * \defgroup Tcp Tcp
  *
  * \section Tcp Overview