00001 /** 00002 * \mainpage ns-3 Documentation 00003 * 00004 * \section intro-sec Introduction 00005 * <a href="http://www.nsnam.org/">ns-3</a> documentation is maintained using 00006 * <a href="http://www.doxygen.org">Doxygen</a>. 00007 * Doxygen is typically used for 00008 * API documentation, and organizes such documentation across different 00009 * modules. This project uses Doxygen both for building the manual around 00010 * the API documentation, and a separate GNU texinfo document is used for 00011 * the manual. 00012 * 00013 * The ns-3 project documentation is organized as follows: 00014 * - <b><a href="modules.html">modules</a></b>: The "Modules" tab (above) 00015 * organizes all of the public API and supporting manual text 00016 * along the source code directory structure. This forms the 00017 * "ns-3 manual", and it is available in HTML and PDF forms. 00018 * - \ref howtos-anchor "HOWTOs": A set of HOWTOs and FAQs is 00019 * maintained on another Doxygen "Related Page" 00020 * - <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>. 00021 * - The <b><a href="http://www.nsnam.org/wiki/index.php/Main_Page">ns-3 wiki</a></b> 00022 * contains additional user-contributed material. Some wiki-contributed 00023 * material may migrate to and overlap with the Doxygen information. 00024 * 00025 * \section install-sec Building the Documentation 00026 * 00027 * ns-3 requires Doxygen version 1.5.4 or greater to fully build all items, 00028 * although earlier versions of Doxygen will mostly work. 00029 * 00030 * Type "./waf check" followed by "./waf --doxygen" to build the documentation. 00031 * There is a program that runs during "./waf check" that builds pieces of 00032 * the documentation through introspection. The doc/ directory contains 00033 * configuration for Doxygen (doxygen.conf and main.txt). The Doxygen 00034 * build process puts html files into the doc/html/ directory, and latex 00035 * filex into the doc/latex/ directory. 00036 * 00037 * \section module-sec Module overview 00038 * 00039 * The ns-3 library is split across multiple modules: 00040 * - core: located in src/core and contains a number of facilities which 00041 * do not depend on any other module. Some of these facilities are 00042 * OS-dependent. 00043 * - simulator: located in src/simulator and contains event scheduling 00044 * facilities. 00045 * - common: located in src/common and contains facilities specific 00046 * to network simulations but shared by pretty much every model 00047 * of a network component. 00048 * - node: located in src/node. Defines the abstract interfaces which 00049 * must be implemented by every node and more specifically, by ipv4 nodes. 00050 * - devices: located in src/devices. Contains a set of MAC-level models 00051 * 00052 * More detail can be found in the <b><a href="modules.html">Modules</a></b> 00053 * tab. 00054 * 00055 */ 00056 /** 00057 * \namespace ns3 00058 * \brief Every class exported by the ns3 library is enclosed in the 00059 * ns3 namespace. 00060 */ 00061