| author | Tom Henderson <tomh@tomh.org> |
| Fri, 13 Nov 2009 13:25:14 -0800 | |
| changeset 5519 | 9a6919579d4e |
| parent 5516 | 57091d4dcf6f |
| child 5528 | 9d076609fc80 |
| permissions | -rw-r--r-- |
| 2217 | 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 |
|
| 5519 | 9 |
* modules. This project uses Doxygen for building the definitive |
10 |
* maintained API documentation, Separate GNU texinfo documents are used for |
|
11 |
* a tutorial, reference manual, and testing and validation manual. |
|
| 2217 | 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 |
|
| 5519 | 16 |
* along the source code directory structure. |
17 |
* - <a href="http://www.nsnam.org/tutorials.html">tutorial</a>: The ns-3 tutorial is a separate document maintained in <a href="http://www.gnu.org/software/texinfo/"> GNU Texinfo</a>. |
|
18 |
* - <a href="http://www.nsnam.org/tutorials.html">Reference manual</a>: The ns-3 reference manual is a separate document maintained in <a href="http://www.gnu.org/software/texinfo/"> GNU Texinfo</a>. |
|
19 |
* - <a href="http://www.nsnam.org/tutorials.html">Testing and validation manual</a>: The ns-3 testing and validation manual is a separate document maintained in <a href="http://www.gnu.org/software/texinfo/"> GNU Texinfo</a>. |
|
| 2217 | 20 |
* - The <b><a href="http://www.nsnam.org/wiki/index.php/Main_Page">ns-3 wiki</a></b> |
21 |
* contains additional user-contributed material. Some wiki-contributed |
|
| 5516 | 22 |
* material may migrate to and overlap with the Doxygen and manual information. |
| 2217 | 23 |
* |
24 |
* \section install-sec Building the Documentation |
|
25 |
* |
|
26 |
* ns-3 requires Doxygen version 1.5.4 or greater to fully build all items, |
|
27 |
* although earlier versions of Doxygen will mostly work. |
|
28 |
* |
|
|
5393
a6e7bcc3539f
update doc/main.h to say ./waf doxygen builds documentation
Craig Dowell <craigdo@ee.washington.edu>
parents:
4534
diff
changeset
|
29 |
* Type "./waf doxygen" to build the documentation. The doc/ directory contains |
| 2217 | 30 |
* configuration for Doxygen (doxygen.conf and main.txt). The Doxygen |
31 |
* build process puts html files into the doc/html/ directory, and latex |
|
32 |
* filex into the doc/latex/ directory. |
|
33 |
* |
|
34 |
* \section module-sec Module overview |
|
35 |
* |
|
36 |
* The ns-3 library is split across multiple modules: |
|
37 |
* - core: located in src/core and contains a number of facilities which |
|
38 |
* do not depend on any other module. Some of these facilities are |
|
39 |
* OS-dependent. |
|
40 |
* - simulator: located in src/simulator and contains event scheduling |
|
41 |
* facilities. |
|
42 |
* - common: located in src/common and contains facilities specific |
|
43 |
* to network simulations but shared by pretty much every model |
|
44 |
* of a network component. |
|
45 |
* - node: located in src/node. Defines the abstract interfaces which |
|
46 |
* must be implemented by every node and more specifically, by ipv4 nodes. |
|
47 |
* - devices: located in src/devices. Contains a set of MAC-level models |
|
48 |
* |
|
49 |
* More detail can be found in the <b><a href="modules.html">Modules</a></b> |
|
50 |
* tab. |
|
51 |
* |
|
52 |
*/ |
|
53 |
/** |
|
54 |
* \namespace ns3 |
|
55 |
* \brief Every class exported by the ns3 library is enclosed in the |
|
56 |
* ns3 namespace. |
|
57 |
*/ |
|
58 |