author | Tom Henderson <tomh@tomh.org> |
Mon, 19 Mar 2018 10:40:32 -0700 | |
changeset 13418 | 82d130348a36 |
parent 13086 | dc88780f21fb |
permissions | -rw-r--r-- |
13086
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
1 |
/** |
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
2 |
* \file |
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
3 |
* Main page of the Doxygen-generated documentation. |
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
4 |
*/ |
2217 | 5 |
/** |
6 |
* \mainpage ns-3 Documentation |
|
7 |
* |
|
8 |
* \section intro-sec Introduction |
|
9 |
* <a href="http://www.nsnam.org/">ns-3</a> documentation is maintained using |
|
10 |
* <a href="http://www.doxygen.org">Doxygen</a>. |
|
11 |
* Doxygen is typically used for |
|
12 |
* API documentation, and organizes such documentation across different |
|
5519 | 13 |
* modules. This project uses Doxygen for building the definitive |
7327
5b8672bfade6
Fix stale links from doxygen main page
Tom Henderson <tomh@tomh.org>
parents:
7233
diff
changeset
|
14 |
* maintained API documentation. Additional ns-3 project documentation |
5b8672bfade6
Fix stale links from doxygen main page
Tom Henderson <tomh@tomh.org>
parents:
7233
diff
changeset
|
15 |
* can be found at the |
5b8672bfade6
Fix stale links from doxygen main page
Tom Henderson <tomh@tomh.org>
parents:
7233
diff
changeset
|
16 |
* <a href="http://www.nsnam.org/documentation/latest">project web site</a>. |
2217 | 17 |
* |
18 |
* \section install-sec Building the Documentation |
|
19 |
* |
|
11073
ea9a2f4eba05
update Doxygen version required
Tom Henderson <tomh@tomh.org>
parents:
10654
diff
changeset
|
20 |
* ns-3 requires Doxygen version 1.8.3.1 or greater. |
2217 | 21 |
* |
5528 | 22 |
* Type "./waf --doxygen" or "./waf --doxygen-no-build" to build the |
23 |
* documentation. The doc/ directory contains |
|
24 |
* configuration for Doxygen (doxygen.conf) and main.h. The Doxygen |
|
2217 | 25 |
* build process puts html files into the doc/html/ directory, and latex |
26 |
* filex into the doc/latex/ directory. |
|
27 |
* |
|
28 |
* \section module-sec Module overview |
|
29 |
* |
|
7327
5b8672bfade6
Fix stale links from doxygen main page
Tom Henderson <tomh@tomh.org>
parents:
7233
diff
changeset
|
30 |
* The ns-3 library is split across many modules organized under the |
5b8672bfade6
Fix stale links from doxygen main page
Tom Henderson <tomh@tomh.org>
parents:
7233
diff
changeset
|
31 |
* <b><a href="modules.html">Modules</a></b> tab. |
7233
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
32 |
* - aodv |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
33 |
* - applications |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
34 |
* - bridge |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
35 |
* - click |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
36 |
* - config-store |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
37 |
* - core |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
38 |
* - csma |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
39 |
* - csma-layout |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
40 |
* - dsdv |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
41 |
* - emu |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
42 |
* - energy |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
43 |
* - flow-monitor |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
44 |
* - internet |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
45 |
* - lte |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
46 |
* - mesh |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
47 |
* - mobility |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
48 |
* - mpi |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
49 |
* - netanim |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
50 |
* - network |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
51 |
* - nix-vector-routing |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
52 |
* - ns3tcp |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
53 |
* - ns3wifi |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
54 |
* - olsr |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
55 |
* - openflow |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
56 |
* - point-to-point |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
57 |
* - point-to-point-layout |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
58 |
* - propagation |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
59 |
* - spectrum |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
60 |
* - stats |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
61 |
* - tap-bridge |
11949
46168afb1e3a
traffic-control: Add the traffic control layer
Natale Patriciello <natale.patriciello@gmail.com>
parents:
11073
diff
changeset
|
62 |
* - traffic-control |
7233
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
63 |
* - test |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
64 |
* - topology-read |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
65 |
* - uan |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
66 |
* - virtual-net-device |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
67 |
* - visualizer |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
68 |
* - wifi |
be0d7443b4ff
Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents:
7145
diff
changeset
|
69 |
* - wimax |
2217 | 70 |
* |
71 |
*/ |
|
72 |
/** |
|
73 |
* \namespace ns3 |
|
74 |
* \brief Every class exported by the ns3 library is enclosed in the |
|
75 |
* ns3 namespace. |
|
76 |
*/ |
|
77 |
||
13086
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
78 |
|
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
79 |
/** |
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
80 |
* \name Macros defined by the build system. |
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
81 |
* |
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
82 |
* These have to be visible for doxygen to document them, |
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
83 |
* so we put them here in a file only seen by doxygen, not the compiler. |
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
84 |
* |
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
85 |
* @{ |
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
86 |
*/ |
10654
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
87 |
/** |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
88 |
* \ingroup assert |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
89 |
* |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
90 |
* \def NS3_ASSERT_ENABLE |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
91 |
* |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
92 |
* Enable asserts at compile time. |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
93 |
* |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
94 |
* This is normally set by `./waf configure --build-profile=debug`. |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
95 |
*/ |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
96 |
#define NS3_ASSERT_ENABLE |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
97 |
|
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
98 |
/** |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
99 |
* \ingroup logging |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
100 |
* |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
101 |
* \def NS3_LOG_ENABLE |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
102 |
* |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
103 |
* Enable logging at compile time. |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
104 |
* |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
105 |
* This is normally set by `./waf configure --build-profile=debug`. |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
106 |
*/ |
0148f9c47331
[doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
9844
diff
changeset
|
107 |
#define NS3_LOG_ENABLE |
13086
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
108 |
|
dc88780f21fb
[doxy] Refactor top level groups core, examples, tests, util
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents:
11949
diff
changeset
|
109 |
/**@}*/ |