A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
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
* - lorawan
48
* - lte
49
* - mesh
50
* - mobility
51
* - mpi
52
* - netanim
53
* - network
54
* - nix-vector-routing
55
* - ns3tcp
56
* - ns3wifi
57
* - olsr
58
* - openflow
59
* - point-to-point
60
* - point-to-point-layout
61
* - propagation
62
* - spectrum
63
* - stats
64
* - tap-bridge
65
* - traffic-control
66
* - test
67
* - topology-read
68
* - uan
69
* - virtual-net-device
70
* - visualizer
71
* - wifi
72
* - wimax
73
*
74
*/
75
76
/**
77
* \namespace ns3
78
* \brief Every class exported by the ns3 library is enclosed in the
79
* ns3 namespace.
80
*/
81
82
/**
83
* \name Macros defined by the build system.
84
*
85
* These have to be visible for doxygen to document them,
86
* so we put them here in a file only seen by doxygen, not the compiler.
87
*
88
* @{
89
*/
90
/**
91
* \ingroup assert
92
*
93
* \def NS3_ASSERT_ENABLE
94
*
95
* Enable asserts at compile time.
96
*
97
* This is normally set by `./ns3 configure --build-profile=debug`.
98
*/
99
#define NS3_ASSERT_ENABLE
100
101
/**
102
* \ingroup logging
103
*
104
* \def NS3_LOG_ENABLE
105
*
106
* Enable logging at compile time.
107
*
108
* This is normally set by `./ns3 configure --build-profile=debug`.
109
*/
110
#define NS3_LOG_ENABLE
111
112
/**@}*/
113
114
/**
115
* \page EnvironVar All Environment Variables
116
*
117
* All environment variables used by ns-3 are documented by module.
118
*
119
* \section environcore Core Environment Variables
120
* See \ref core-environ
121
*/
doc
main.h
Generated on Fri Nov 8 2024 13:58:58 for ns-3 by
1.11.0