doc/main.h
author Tom Henderson <tomh@tomh.org>
Fri, 30 Jan 2015 11:34:38 -0800
changeset 11188 e010083f6592
parent 11073 ea9a2f4eba05
permissions -rw-r--r--
fix possibly uninitialized variable warning
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     1
/**
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     2
 * \mainpage ns-3 Documentation
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     3
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     4
 * \section intro-sec Introduction
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     5
 * <a href="http://www.nsnam.org/">ns-3</a> documentation is maintained using 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     6
 * <a href="http://www.doxygen.org">Doxygen</a>.
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     7
 * Doxygen is typically used for 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     8
 * API documentation, and organizes such documentation across different
5519
9a6919579d4e update doxygen main page
Tom Henderson <tomh@tomh.org>
parents: 5516
diff changeset
     9
 * 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
    10
 * 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
    11
 * can be found at the
5b8672bfade6 Fix stale links from doxygen main page
Tom Henderson <tomh@tomh.org>
parents: 7233
diff changeset
    12
 * <a href="http://www.nsnam.org/documentation/latest">project web site</a>.
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    13
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    14
 * \section install-sec Building the Documentation
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    15
 * 
11073
ea9a2f4eba05 update Doxygen version required
Tom Henderson <tomh@tomh.org>
parents: 10654
diff changeset
    16
 * ns-3 requires Doxygen version 1.8.3.1 or greater.
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    17
 * 
5528
9d076609fc80 further updates to main.h
Tom Henderson <tomh@tomh.org>
parents: 5519
diff changeset
    18
 * Type "./waf --doxygen" or "./waf --doxygen-no-build" to build the 
9d076609fc80 further updates to main.h
Tom Henderson <tomh@tomh.org>
parents: 5519
diff changeset
    19
 *  documentation.  The doc/ directory contains
9d076609fc80 further updates to main.h
Tom Henderson <tomh@tomh.org>
parents: 5519
diff changeset
    20
 * configuration for Doxygen (doxygen.conf) and main.h.  The Doxygen 
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    21
 * build process puts html files into the doc/html/ directory, and latex 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    22
 * filex into the doc/latex/ directory.
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    23
 * 
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    24
 * \section module-sec Module overview
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    25
 *
7327
5b8672bfade6 Fix stale links from doxygen main page
Tom Henderson <tomh@tomh.org>
parents: 7233
diff changeset
    26
 * 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
    27
 * <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
    28
 *     - aodv
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    29
 *     - applications
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    30
 *     - bridge
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    31
 *     - click
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    32
 *     - config-store
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    33
 *     - core
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    34
 *     - csma
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    35
 *     - csma-layout
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    36
 *     - dsdv
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    37
 *     - emu
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    38
 *     - energy
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    39
 *     - flow-monitor
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    40
 *     - internet
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    41
 *     - lte
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    42
 *     - mesh
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    43
 *     - mobility
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    44
 *     - mpi
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    45
 *     - netanim
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    46
 *     - network
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    47
 *     - nix-vector-routing
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    48
 *     - ns3tcp
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    49
 *     - ns3wifi
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    50
 *     - olsr
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    51
 *     - openflow
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    52
 *     - point-to-point
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    53
 *     - point-to-point-layout
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    54
 *     - propagation
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    55
 *     - spectrum
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    56
 *     - stats
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    57
 *     - tap-bridge
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    58
 *     - test
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    59
 *     - topology-read
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    60
 *     - uan
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    61
 *     - virtual-net-device
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    62
 *     - visualizer
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    63
 *     - wifi
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7145
diff changeset
    64
 *     - wimax
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    65
 *
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    66
 */
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    67
/**
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    68
 * \namespace ns3
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    69
 * \brief Every class exported by the ns3 library is enclosed in the
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    70
 * ns3 namespace.
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    71
 */
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    72
10654
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    73
// Macros defined by the build system.
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    74
//
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    75
// These have to be visible for doxygen to document them,
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    76
// so we put them here in a file only seen by doxygen, not the compiler.
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    77
/**
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    78
 * \ingroup assert
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    79
 *
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    80
 * \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
    81
 *
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    82
 * 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
    83
 *
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    84
 * 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
    85
 */
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    86
#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
    87
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    88
/**
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    89
 * \ingroup logging
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    90
 *
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    91
 * \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
    92
 *
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    93
 * 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
    94
 *
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    95
 * 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
    96
 */
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9844
diff changeset
    97
#define NS3_LOG_ENABLE