ns-3 Documentation


ns-3 documentation is maintained using Doxygen. Doxygen is typically used for API documentation, and organizes such documentation across different modules. This project uses Doxygen for building the definitive maintained API documentation, Separate GNU texinfo documents are used for a tutorial, reference manual, and testing and validation manual.

The ns-3 project documentation is organized as follows:

Building the Documentation

ns-3 requires Doxygen version 1.5.4 or greater to fully build all items, although earlier versions of Doxygen will mostly work.

Type "./waf --doxygen" or "./waf --doxygen-no-build" to build the documentation. The doc/ directory contains configuration for Doxygen (doxygen.conf) and main.h. The Doxygen build process puts html files into the doc/html/ directory, and latex filex into the doc/latex/ directory.

Module overview

The ns-3 library is split across multiple modules:

More detail can be found in the Modules tab.