Order model library document by module and make visualizer show up in doxygen
authorMitch Watrous <watrous@u.washington.edu>
Tue, 24 May 2011 14:27:52 -0700
changeset 7263 7ebd56e409cf
parent 7262 4ba3ce00eb3c
child 7264 0b427a69e2fc
Order model library document by module and make visualizer show up in doxygen
doc/doxygen.conf
doc/models/source/index.rst
doc/models/source/organization.rst
--- a/doc/doxygen.conf	Mon May 23 16:36:19 2011 -0400
+++ b/doc/doxygen.conf	Tue May 24 14:27:52 2011 -0700
@@ -607,9 +607,7 @@
                          src/olsr/model/olsr-repositories.h \
                          src/core/model/high-precision.h \
                          src/core/model/high-precision-128.h \
-                         src/core/model/high-precision-double.h \
-                         src/visualizer/model/visual-simulator-impl.h \
-                         src/visualizer/model/pyviz.h
+                         src/core/model/high-precision-double.h
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix filesystem feature) are excluded
--- a/doc/models/source/index.rst	Mon May 23 16:36:19 2011 -0400
+++ b/doc/models/source/index.rst	Tue May 24 14:27:52 2011 -0700
@@ -19,13 +19,24 @@
    :maxdepth: 2
 
    organization
-   network
-   devices
-   propagation
+   animation
+   applications
+   bridge
+   click
+   csma
+   emulation-overview
    energy
+   flow-monitor
    internet-models
-   routing
+   lte
+   mesh
    distributed
-   emulation-overview
-   applications
-   support
+   network
+   openflow-switch
+   point-to-point
+   propagation
+   simple
+   statistics
+   uan
+   wifi
+   wimax
--- a/doc/models/source/organization.rst	Mon May 23 16:36:19 2011 -0400
+++ b/doc/models/source/organization.rst	Tue May 24 14:27:52 2011 -0700
@@ -33,20 +33,15 @@
 Finally, additional documentation about various aspects of |ns3| may
 exist on the `project wiki <http://www.nsnam.org/wiki>`_).
 
-We organize this model library documentation loosely as follows.
-We start with the models found in the ``src/network`` module, as this 
-module contains some fundamental models for the simulator.
+A sample outline of how to write model library documentation can be
+found in :mod:`src/template/doc`.
+
+The remainder of this document is organized alphabetically by module name.
+
+If you are new to ns3, you might first want to read below about the network
+module, which contains some fundamental models for the simulator.
 The packet model, models for different address formats, and abstract 
 base classes for objects such as nodes, net devices, channels, sockets, and 
-applications are discussed here.    
-
-We next group documentation under the following major headings:
+applications are discussed there.
 
-* Devices and Channels
-* Emulation
-* Internet Models
-* Applications
-* Support
 
-A sample outline of how to write model library documentation can be
-found in :mod:`src/template/doc`.