Doxygen for internet-node.h
authorTom Henderson <tomh@tomh.org>
Wed, 26 Dec 2007 11:39:52 -0800
changeset 2200 cc3c72489498
parent 2199 fd70fd33b046
child 2201 498eb8135a8e
Doxygen for internet-node.h
doc/doxygen.conf
src/internet-node/internet-node.h
--- a/doc/doxygen.conf	Wed Dec 26 15:41:48 2007 +0100
+++ b/doc/doxygen.conf	Wed Dec 26 11:39:52 2007 -0800
@@ -496,7 +496,8 @@
 INPUT                  = src \
                          doc/main.txt \
                          doc/introspected-doxygen.h \
-                         doc/tracing.h
+                         doc/tracing.h \
+                         doc/tutorial.h
 
 # This tag can be used to specify the character encoding of the source files that 
 # doxygen parses. Internally doxygen uses the UTF-8 encoding, which is also the default 
--- a/src/internet-node/internet-node.h	Wed Dec 26 15:41:48 2007 +0100
+++ b/src/internet-node/internet-node.h	Wed Dec 26 11:39:52 2007 -0800
@@ -31,6 +31,29 @@
 
 namespace ns3 {
 
+/**
+ * \defgroup InternetNode InternetNode
+ *
+ * \section InternetNode Overview
+ *
+ * The InternetNode module contains an implementation of TCP, UDP, and
+ * IPv4.  ns-3 Applications sit above this module, and ns-3 NetDevices
+ * sit below it...
+ *
+ * InternetNode is implemented as a subclass of Node but this may be
+ * refactored in the future to 
+ */
+
+/*
+ * \brief Container class for various TCP/IP objects and interfaces
+ * aggregated to a Node.
+ *
+ * This class exists primarily to assemble the layer-3/4 stack of a Node 
+ * from constituent parts, including implementations of TCP, IPv4, UDP, 
+ * and ARP.  It provides only constructors and destructors as its public
+ * API.  Internally, the various protocols are instantiated, aggregated
+ * to a Node, and plumbed together.
+ */
 class InternetNode : public Node 
 {
 public: