1 /**

     2  * \mainpage ns-3 Documentation

     3  *

     4  * \section intro-sec Introduction

     5  * <a href="http://www.nsnam.org/">ns-3</a> documentation is maintained using 

     6  * <a href="http://www.doxygen.org">Doxygen</a>.

     7  * Doxygen is typically used for 

     8  * API documentation, and organizes such documentation across different

     9  * modules.   This project uses Doxygen both for building the manual around 

    10  * the API documentation,  and a separate GNU texinfo document is used for 

    11  * the manual.

    12  *

    13  * The ns-3 project documentation is organized as follows:

    14  *     - <b><a href="modules.html">modules</a></b>:  The "Modules" tab (above) 

    15  *       organizes  all of the public API and supporting manual text 

    16  *       along the  source code directory structure.   This forms the 

    17  *       "ns-3 manual", and it is available in HTML and PDF forms.

    18  *     - \ref howtos-anchor "HOWTOs": A set of HOWTOs and FAQs is

    19  *       maintained on another Doxygen "Related Page" 

    20  *     - <a href="http://www.nsnam.org/docs/tutorial/tutorial.html">tutorial</a>:  The ns-3 tutorial is a separate document maintained in <a href="http://www.gnu.org/software/texinfo/"> GNU Texinfo</a>. 

    21  *     - The <b><a href="http://www.nsnam.org/wiki/index.php/Main_Page">ns-3 wiki</a></b> 

    22  *       contains additional user-contributed material.  Some wiki-contributed

    23  *       material may migrate to and overlap with the Doxygen information.

    24  *

    25  * \section install-sec Building the Documentation

    26  * 

    27  * ns-3 requires Doxygen version 1.5.4 or greater to fully build all items,

    28  * although earlier versions of Doxygen will mostly work.

    29  * 

    30  * Type "./waf check" followed by "./waf --doxygen" to build the documentation.

    31  * There is a program that runs during "./waf check" that builds pieces of

    32  * the documentation through introspection.  The doc/ directory contains

    33  * configuration for Doxygen (doxygen.conf and main.txt).  The Doxygen 

    34  * build process puts html files into the doc/html/ directory, and latex 

    35  * filex into the doc/latex/ directory.

    36  * 

    37  * \section module-sec Module overview

    38  *

    39  * The ns-3 library is split across multiple modules:

    40  *     - core: located in src/core and contains a number of facilities which

    41  *       do not depend on any other module. Some of these facilities are

    42  *       OS-dependent.

    43  *     - simulator: located in src/simulator and contains event scheduling

    44  *       facilities.

    45  *     - common: located in src/common and contains facilities specific

    46  *       to network simulations but shared by pretty much every model

    47  *       of a network component.

    48  *     - node: located in src/node. Defines the abstract interfaces which 

    49  *       must be implemented by every node and more specifically, by ipv4 nodes.       

    50  *     - devices: located in src/devices. Contains a set of MAC-level models

    51  *

    52  * More detail can be found in the <b><a href="modules.html">Modules</a></b>

    53  * tab.

    54  *

    55  */

    56 /**

    57  * \namespace ns3

    58  * \brief Every class exported by the ns3 library is enclosed in the

    59  * ns3 namespace.

    60  */

    61