diff --git a/doc/doxygen.conf b/doc/doxygen.conf index 476854249..476d8c6c5 100644 --- a/doc/doxygen.conf +++ b/doc/doxygen.conf @@ -496,7 +496,8 @@ WARN_LOGFILE = 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 diff --git a/src/internet-node/internet-node.h b/src/internet-node/internet-node.h index 5298ecb2d..165db3ff0 100644 --- a/src/internet-node/internet-node.h +++ b/src/internet-node/internet-node.h @@ -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: