F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen for internet-node.h

Browse Source
This commit is contained in:
Tom Henderson
2007-12-26 11:39:52 -08:00
parent 853f0a13e9
commit 33fd7f0c67
2 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/doxygen.conf
View File

@@ -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

23
src/internet-node/internet-node.h
View File

@@ -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: