Introduction

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. Additional ns-3 project documentation can be found at the project web site.

Building the Documentation

Building ns-3 Doxygen requires Doxygen version 1.8 at a minimum, but version 1.9 is recommended to minimize warnings.

Type "./ns3 docs doxygen" or "./ns3 docs 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 many modules organized under the Modules tab.

aodv
applications
bridge
click
config-store
core
csma
csma-layout
dsdv
emu
energy
flow-monitor
internet
lte
mesh
mobility
mpi
netanim
network
nix-vector-routing
ns3tcp
ns3wifi
olsr
openflow
point-to-point
point-to-point-layout
propagation
spectrum
stats
tap-bridge
traffic-control
test
topology-read
uan
virtual-net-device
visualizer
wifi
wimax