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.11
22 *
23 * Type "./ns3 docs doxygen" or "./ns3 docs doxygen-no-build" to build the
24 * documentation. The doc/ directory contains
25 * configuration for Doxygen (doxygen.conf) and main.h. The Doxygen
26 * build process puts html files into the doc/html/ directory, and latex
27 * filex into the doc/latex/ directory.
28 *
29 * @section topics-sec Doxygen groups
30 *
31 * The ns-3 library is split across many modules, and the Doxygen for these modules is typically
32 * added to <a href ="https://www.doxygen.nl/manual/grouping.html">Doxygen groups</a>.
33 * These groupings can be browsed under the <b><a href="topics.html">Topics</a></b> tab.
34 */
35
36/**
37 * @namespace ns3
38 * @brief Every class exported by the ns3 library is enclosed in the
39 * ns3 namespace.
40 */
41
42/**
43 * @name Macros defined by the build system.
44 *
45 * These have to be visible for doxygen to document them,
46 * so we put them here in a file only seen by doxygen, not the compiler.
47 *
48 * @{
49 */
50/**
51 * @ingroup assert
52 *
53 * @def NS3_ASSERT_ENABLE
54 *
55 * Enable asserts at compile time.
56 *
57 * This is normally set by `./ns3 configure --build-profile=debug`.
58 */
59#define NS3_ASSERT_ENABLE
60
61/**
62 * @ingroup logging
63 *
64 * @def NS3_LOG_ENABLE
65 *
66 * Enable logging at compile time.
67 *
68 * This is normally set by `./ns3 configure --build-profile=debug`.
69 */
70#define NS3_LOG_ENABLE
71
72/**@}*/
73
74/**
75 * @page EnvironVar All Environment Variables
76 *
77 * All environment variables used by ns-3 are documented by module.
78 *
79 * @section environcore Core Environment Variables
80 * See \ref core-environ
81 */