doc/modules
author Tom Henderson <tomh@tomh.org>
Thu, 05 Feb 2015 13:02:44 -0800
changeset 11214 103f62fc7d58
parent 10654 0148f9c47331
permissions -rw-r--r--
small edits on previous commit
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
 * @anchor modules_anchor
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
     3
 *
7233
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7149
diff changeset
     4
 * @defgroup constants Constants
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7149
diff changeset
     5
 * @brief Constants you can change
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7149
diff changeset
     6
 *
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7149
diff changeset
     7
 * @defgroup utils Utils
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7149
diff changeset
     8
 * @brief The utils directory is for various programs and scripts related 
be0d7443b4ff Updated the modules doxygen page
Mitch Watrous <watrous@u.washington.edu>
parents: 7149
diff changeset
     9
 * to code coverage, test suites, style checking, and benchmarking.
10654
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    10
 */
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    11
/**
7147
71adbc0422a5 Fix more paths in the documentation
Mitch Watrous <watrous@u.washington.edu>
parents: 6736
diff changeset
    12
 * @defgroup core Core
71adbc0422a5 Fix more paths in the documentation
Mitch Watrous <watrous@u.washington.edu>
parents: 6736
diff changeset
    13
 * \brief The "core" module contains:
10654
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    14
 *    - a time management class to hold a time and convert between various
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    15
 *      time units: ns3::Time 
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    16
 *    - a scheduler base class used to implement new simulation event
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    17
 *      schedulers:       
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    18
 *      ns3::Scheduler and ns3::SchedulerFactory 
10654
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    19
 *    - a simulator class used to create, schedule and cancel events:
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    20
 *      ns3::Simulator
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    21
 *    - a Functor class: ns3::Callback  
10654
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    22
 *    - an os-independent interface to get access to the elapsed wall clock
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    23
 *      time: ns3::SystemWallClockMs 
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    24
 *    - a class to register regression tests with the test manager: ns3::Test
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    25
 *      and ns3::TestManager
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    26
 *    - debugging facilities: \ref debugging
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    27
 *    - \ref randomvariable
10654
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    28
 *    - a base class for objects which need to support per-instance
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    29
 *      "attributes" and trace sources: ns3::ObjectBase
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    30
 *    - a base class for objects which need to support reference counting
2963
40a70a2e1b70 fix some dox warnings
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 2891
diff changeset
    31
 *      and dynamic object aggregation: ns3::Object
10654
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    32
 *    - a smart-pointer class ns3::Ptr designed to work together with
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    33
 *      ns3::Object
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    34
 *    - a configuration class used to set and control all attributes and
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    35
 *      trace sources in a simulation: ns3::Config.
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    36
 */
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    37
/**
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    38
 * @ingroup core
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    39
 * @defgroup debugging Debugging tools
2217
0b4567d545de Doxygen organization
Tom Henderson <tomh@tomh.org>
parents:
diff changeset
    40
 *
10654
0148f9c47331 [doxygen] Make introspected lists more visible, various other doxy
Peter D. Barnes, Jr. <barnes26@llnl.gov>
parents: 9971
diff changeset
    41
 * @brief Assertions, breakpoints, logging, and abnormal program termination
3183
fc3b2e03e61e more doxygen
Tom Henderson <tomh@tomh.org>
parents: 2963
diff changeset
    42
 */