A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
main.h
Go to the documentation of this file.
1/**
2 * \file
3 * Main page of the Doxygen-generated documentation.
4 */
5
6/**
7 * \mainpage ns-3 Documentation
8 *
9 * \section intro-sec Introduction
10 * <a href="http://www.nsnam.org/">ns-3</a> documentation is maintained using
11 * <a href="http://www.doxygen.org">Doxygen</a>.
12 * Doxygen is typically used for
13 * API documentation, and organizes such documentation across different
14 * modules. This project uses Doxygen for building the definitive
15 * maintained API documentation. Additional ns-3 project documentation
16 * can be found at the
17 * <a href="http://www.nsnam.org/documentation/latest">project web site</a>.
18 *
19 * \section install-sec Building the Documentation
20 *
21 * Building ns-3 Doxygen requires Doxygen version 1.8 at a minimum, but version 1.9 is recommended
22 * to minimize warnings.
23 *
24 * Type "./ns3 docs doxygen" or "./ns3 docs doxygen-no-build" to build the
25 * documentation. The doc/ directory contains
26 * configuration for Doxygen (doxygen.conf) and main.h. The Doxygen
27 * build process puts html files into the doc/html/ directory, and latex
28 * filex into the doc/latex/ directory.
29 *
30 * \section module-sec Module overview
31 *
32 * The ns-3 library is split across many modules organized under the
33 * <b><a href="modules.html">Modules</a></b> tab.
34 * - aodv
35 * - applications
36 * - bridge
37 * - click
38 * - config-store
39 * - core
40 * - csma
41 * - csma-layout
42 * - dsdv
43 * - emu
44 * - energy
45 * - flow-monitor
46 * - internet
47 * - lte
48 * - mesh
49 * - mobility
50 * - mpi
51 * - netanim
52 * - network
53 * - nix-vector-routing
54 * - ns3tcp
55 * - ns3wifi
56 * - olsr
57 * - openflow
58 * - point-to-point
59 * - point-to-point-layout
60 * - propagation
61 * - spectrum
62 * - stats
63 * - tap-bridge
64 * - traffic-control
65 * - test
66 * - topology-read
67 * - uan
68 * - virtual-net-device
69 * - visualizer
70 * - wifi
71 * - wimax
72 *
73 */
74
75/**
76 * \namespace ns3
77 * \brief Every class exported by the ns3 library is enclosed in the
78 * ns3 namespace.
79 */
80
81/**
82 * \name Macros defined by the build system.
83 *
84 * These have to be visible for doxygen to document them,
85 * so we put them here in a file only seen by doxygen, not the compiler.
86 *
87 * @{
88 */
89/**
90 * \ingroup assert
91 *
92 * \def NS3_ASSERT_ENABLE
93 *
94 * Enable asserts at compile time.
95 *
96 * This is normally set by `./ns3 configure --build-profile=debug`.
97 */
98#define NS3_ASSERT_ENABLE
99
100/**
101 * \ingroup logging
102 *
103 * \def NS3_LOG_ENABLE
104 *
105 * Enable logging at compile time.
106 *
107 * This is normally set by `./ns3 configure --build-profile=debug`.
108 */
109#define NS3_LOG_ENABLE
110
111/**@}*/
112
113/**
114 * \page EnvironVar All Environment Variables
115 *
116 * All environment variables used by ns-3 are documented by module.
117 *
118 * \section environcore Core Environment Variables
119 * See \ref core-environ
120 */