split manual; create model library

.hgignore

@@ -17,6 +17,8 @@
 ^doc/manual/build
 ^doc/tutorial/build
 ^doc/testing/build
+^doc/models/build
+^doc/models/source-temp
 ^doc/manual/figures/.*eps
 ^doc/manual/figures/.*pdf
 ^doc/manual/figures/.*png

doc/manual/Makefile

@@ -6,39 +6,10 @@ FIGURES = figures
 VPATH = $(FIGURES)
 
 IMAGES_EPS = \
-	$(FIGURES)/internet-node-send.eps \
-	$(FIGURES)/internet-node-recv.eps \
-	$(FIGURES)/packet.eps \
-	$(FIGURES)/node.eps \
-	$(FIGURES)/buffer.eps \
-	$(FIGURES)/sockets-overview.eps \
 	$(FIGURES)/software-organization.eps \
-	$(FIGURES)/routing.eps \
-	$(FIGURES)/routing-specialization.eps \
-	$(FIGURES)/testbed.eps \
-	$(FIGURES)/emulated-channel.eps \
-	$(FIGURES)/snir.eps \
-	$(FIGURES)/WifiArchitecture.eps \
-	$(FIGURES)/WimaxArchitecture.eps \
-        $(FIGURES)/auvmobility-classes.eps \
 
-# missing figure 
-#        $(FIGURES)/lte-transmission.eps
 
-$(FIGURES)/node.pdf_width = 5in
-$(FIGURES)/testbed.pdf_width = 5in
-$(FIGURES)/emulated-channel.pdf_width = 6in
-$(FIGURES)/internet-node-send.pdf_width = 5in
-$(FIGURES)/internet-node-recv.pdf_width = 5in
 $(FIGURES)/software-organization.pdf_width = 5in
-$(FIGURES)/packet.pdf_width = 4in
-$(FIGURES)/buffer.pdf_width = 15cm
-$(FIGURES)/routing.pdf_width = 6in
-$(FIGURES)/routing-specialization.pdf_width = 5in
-$(FIGURES)/sockets-overview.pdf_width = 10cm
-$(FIGURES)/snir.pdf_width = 3in
-$(FIGURES)/lte-transmission.pdf_width = 3in
-$(FIGURES)/auvmobility-classes.pdf_width = 10cm
 IMAGES_PNG = ${IMAGES_EPS:.eps=.png}
 IMAGES_PDF = ${IMAGES_EPS:.eps=.pdf}
 

doc/manual/source/core.rst

@@ -1,17 +0,0 @@
-Core
-----
-
-.. toctree::
-
-    random-variables
-    callbacks
-    object-model
-    attributes
-    object-names
-    logging
-    tracing
-    realtime
-    distributed
-    packets
-    helpers
-    python

doc/manual/source/emulation.rst

@@ -1,8 +0,0 @@
-Emulation
----------
-
-.. toctree::
-
-    emulation-overview
-    emu
-    tap

doc/manual/source/index.rst

@@ -18,9 +18,15 @@ This document is written in `reStructuredText <http://docutils.sourceforge.net/r
    :maxdepth: 2
 
    organization
-   core
-   nodes-and-devices
-   emulation
-   internet-models
-   applications
+   random-variables
+   callbacks
+   object-model
+   attributes
+   object-names
+   logging
+   tracing
+   realtime
+   distributed
+   helpers
+   python
    support

doc/manual/source/nodes-and-devices.rst

@@ -1,18 +0,0 @@
-Node and NetDevices
--------------------
-
-.. toctree::
-
-    nodes-and-devices-overview
-    simple
-    point-to-point
-    csma
-    wifi
-    mesh
-    bridge
-    wimax
-    lte
-    uan
-    energy
-    openflow-switch
-    propagation

doc/manual/source/support.rst

@@ -3,9 +3,6 @@ Support
 
 .. toctree::
 
-   flow-monitor
-   animation
-   statistics
    new-models
    new-modules
    enable-modules

doc/models/Makefile

@@ -0,0 +1,256 @@
+EPSTOPDF = epstopdf
+DIA = dia
+CONVERT = convert
+
+SRC = ../../src
+# Temporary source directory, for build
+SOURCETEMP = source-temp
+FIGURES = $(SOURCETEMP)/figures
+
+# list all model library .rst files that need to be copied to $SOURCETEMP
+SOURCES = \
+	source/conf.py \
+	source/_static \
+	source/index.rst \
+	source/replace.txt \
+	source/organization.rst \
+	source/internet-models.rst \
+	source/network.rst \
+	source/devices.rst \
+	source/routing.rst \
+	source/emulation-overview.rst \
+	source/support.rst \
+	$(SRC)/applications/doc/applications.rst \
+	$(SRC)/bridge/doc/bridge.rst \
+	$(SRC)/click/doc/click.rst \
+	$(SRC)/csma/doc/csma.rst \
+	$(SRC)/mpi/doc/distributed.rst \
+	$(SRC)/energy/doc/energy.rst \
+	$(SRC)/emu/doc/emu.rst \
+	$(SRC)/tap-bridge/doc/tap.rst \
+	$(SRC)/mesh/doc/mesh.rst \
+	$(SRC)/lte/doc/lte.rst \
+	$(SRC)/propagation/doc/propagation.rst \
+	$(SRC)/network/doc/network-overview.rst \
+	$(SRC)/network/doc/packets.rst \
+	$(SRC)/network/doc/sockets-api.rst \
+	$(SRC)/network/doc/simple.rst \
+	$(SRC)/internet/doc/internet-stack.rst \
+	$(SRC)/internet/doc/ipv4.rst \
+	$(SRC)/internet/doc/ipv6.rst \
+	$(SRC)/internet/doc/routing-overview.rst \
+	$(SRC)/internet/doc/tcp.rst \
+	$(SRC)/openflow/doc/openflow-switch.rst \
+	$(SRC)/point-to-point/doc/point-to-point.rst \
+	$(SRC)/wifi/doc/wifi.rst \
+	$(SRC)/wimax/doc/wimax.rst \
+	$(SRC)/uan/doc/uan.rst \
+	$(SRC)/stats/doc/statistics.rst \
+	$(SRC)/netanim/doc/animation.rst \
+	$(SRC)/flow-monitor/doc/flow-monitor.rst \
+
+# list all model library figure files that need to be copied to 
+# $SOURCETEMP/figures.  Either a .dia or both a .pdf and .png
+SOURCEFIGS = \
+	figures/testbed.dia \
+	figures/emulated-channel.dia \
+	$(SRC)/network/doc/packet.dia \
+	$(SRC)/network/doc/node.dia \
+	$(SRC)/network/doc/buffer.dia \
+	$(SRC)/network/doc/sockets-overview.dia \
+	$(SRC)/internet/doc/internet-node-send.dia \
+	$(SRC)/internet/doc/internet-node-recv.dia \
+	$(SRC)/internet/doc/routing.dia \
+	$(SRC)/internet/doc/routing-specialization.dia \
+	$(SRC)/wifi/doc/WifiArchitecture.dia \
+	$(SRC)/wifi/doc/snir.dia \
+	$(SRC)/wimax/doc/WimaxArchitecture.dia \
+	$(SRC)/lte/doc/lte-transmission.png \
+	$(SRC)/lte/doc/lte-transmission.pdf \
+        $(SRC)/uan/doc/auvmobility-classes.dia \
+	$(SRC)/netanim/doc/animation-dumbbell.png \
+	$(SRC)/netanim/doc/animation-dumbbell.pdf \
+
+# specify figures for build process (all dia figures)
+IMAGES_EPS = \
+	$(FIGURES)/testbed.eps \
+	$(FIGURES)/emulated-channel.eps \
+	$(FIGURES)/packet.eps \
+	$(FIGURES)/node.eps \
+	$(FIGURES)/buffer.eps \
+	$(FIGURES)/sockets-overview.eps \
+	$(FIGURES)/internet-node-send.eps \
+	$(FIGURES)/internet-node-recv.eps \
+	$(FIGURES)/routing.eps \
+	$(FIGURES)/routing-specialization.eps \
+	$(FIGURES)/WifiArchitecture.eps \
+	$(FIGURES)/snir.eps \
+	$(FIGURES)/WimaxArchitecture.eps \
+        $(FIGURES)/auvmobility-classes.eps \
+
+# rescale figures as necessary
+$(FIGURES)/testbed.pdf_width = 5in
+$(FIGURES)/emulated-channel.pdf_width = 6in
+$(FIGURES)/node.pdf_width = 5in
+$(FIGURES)/packet.pdf_width = 4in
+$(FIGURES)/buffer.pdf_width = 15cm
+$(FIGURES)/sockets-overview.pdf_width = 10cm
+$(FIGURES)/internet-node-send.pdf_width = 5in
+$(FIGURES)/internet-node-recv.pdf_width = 5in
+$(FIGURES)/routing.pdf_width = 6in
+$(FIGURES)/routing-specialization.pdf_width = 5in
+$(FIGURES)/snir.pdf_width = 3in
+$(FIGURES)/lte-transmission.pdf_width = 3in
+$(FIGURES)/auvmobility-classes.pdf_width = 10cm
+
+IMAGES_PNG = ${IMAGES_EPS:.eps=.png}
+IMAGES_PDF = ${IMAGES_EPS:.eps=.pdf}
+
+IMAGES = $(IMAGES_EPS) $(IMAGES_PNG) $(IMAGES_PDF)
+
+%.eps : %.dia; $(DIA) -t eps $< -e $@
+%.png : %.dia; $(DIA) -t png $< -e $@
+%.pdf : %.eps; $(EPSTOPDF) $< -o=$@; if test x$($@_width) != x; then TMPFILE=`mktemp`; ./rescale-pdf.sh $($@_width) $@ $${TMPFILE} && mv $${TMPFILE} $@; fi
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(SOURCETEMP) 
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+copy-sources:  $(SOURCES)
+	@rm -rf $(SOURCETEMP)
+	@mkdir -p $(SOURCETEMP) 
+	@mkdir -p $(FIGURES) 
+	@cp -r $(SOURCES) $(SOURCETEMP)
+	@cp -r $(SOURCEFIGS) $(FIGURES)
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+	-rm -rf $(SOURCETEMP)
+
+frag: pickle
+	@if test ! -d $(BUILDDIR)/frag; then mkdir $(BUILDDIR)/frag; fi
+	pushd $(BUILDDIR)/frag && ../../pickle-to-xml.py ../pickle/index.fpickle  > navigation.xml && popd
+	cp -r $(BUILDDIR)/pickle/_images $(BUILDDIR)/frag
+
+html: copy-sources $(IMAGES) 
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ns-3.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ns-3.qhc"
+
+devhelp: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/ns-3"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ns-3"
+	@echo "# devhelp"
+
+epub: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck: copy-sources $(IMAGEs)
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest: copy-sources $(IMAGES)
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+

doc/models/rescale-pdf.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+TMPFILE=`mktemp`
+
+echo "\documentclass{book}
+\usepackage{pdfpages}
+\begin{document}
+\includepdf[width=${1},fitpaper]{${2}}
+\end{document}" >${TMPFILE}.tex
+pdflatex -output-directory /tmp ${TMPFILE}.tex >/dev/null 2>/dev/null
+cp ${TMPFILE}.pdf ${3}
+

doc/models/source/README

@@ -0,0 +1,2 @@
+This directory stores .rst files that are used to build the model library
+documentation but that are not stored with a particular module.

doc/models/source/conf.py

@@ -0,0 +1,216 @@
+# -*- coding: utf-8 -*-
+#
+# ns-3 documentation build configuration file, created by
+# sphinx-quickstart on Tue Dec 14 09:00:39 2010.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.pngmath']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'ns-3'
+copyright = u'2011, ns-3 project'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = 'ns-3.11'
+# The full version, including alpha/beta/rc tags.
+release = 'ns-3.11'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ns-3doc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'ns-3-model-library.tex', u'ns-3 Model Library',
+   u'ns-3 project', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'ns-3-model-library', u'ns-3 Model Library',
+     [u'ns-3 project'], 1)
+]

doc/models/source/devices.rst

@@ -0,0 +1,14 @@
+Devices and Channels
+--------------------
+
+.. toctree::
+
+    bridge
+    csma
+    lte
+    point-to-point
+    mesh
+    wifi
+    wimax
+    simple
+    uan

doc/models/source/emulation-overview.rst

@@ -69,3 +69,8 @@ channel.
 We expect the typical use case for this environment will be to analyze the
 behavior of native applications and protocol suites in the presence of large
 simulated |ns3| networks.
+
+.. toctree::
+
+  emu
+  tap

doc/models/source/index.rst

@@ -0,0 +1,31 @@
+.. only:: html or latex
+
+ns-3 Model Library
+==================
+
+This is the *ns-3 manual*. Primary documentation for the ns-3 project is 
+available in four forms:
+
+* `ns-3 Doxygen <http://www.nsnam.org/doxygen/index.html>`_: Documentation of the public APIs of the simulator
+* `Tutorial <http://www.nsnam.org/tutorials.html>`_
+* `Developers Manual <http://www.nsnam.org/tutorials.html>`_
+* `Model Library <http://www.nsnam.org/tutorials.html>`_: *(this document)*
+* `ns-3 wiki <http://www.nsnam.org/wiki/index.php/Main_Page>`_ 
+
+This document is written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ for `Sphinx <http://sphinx.pocoo.org/>`_ and is maintained in the
+``doc/models`` directory of ns-3's source code.
+
+.. toctree::
+   :maxdepth: 2
+
+   organization
+   network
+   devices
+   propagation
+   energy
+   internet-models
+   routing
+   distributed
+   emulation-overview
+   applications
+   support

doc/models/source/internet-models.rst

@@ -3,10 +3,8 @@ Internet Models
 
 .. toctree::
 
-   sockets-api
    internet-stack
    ipv4
    ipv6
-   routing
-   click
+   routing-overview
    tcp

doc/models/source/network.rst

@@ -0,0 +1,9 @@
+Network Module
+--------------
+
+.. toctree::
+
+    packets
+    network-overview
+    sockets-api
+    simple

doc/models/source/organization.rst

@@ -0,0 +1,52 @@
+.. include:: replace.txt
+
+Organization
+------------
+
+This manual compiles documentation for |ns3| models and supporting
+software that enable users to construct network simulations.
+It is important to distinguish between **modules** and **models**:
+
+* |ns3| software is organized into separate *modules* that are each
+  built as a separate software library.  Individual ns-3 programs can link
+  the modules (libraries) they need to conduct their simulation.
+
+* |ns3| *models* are abstract representations of real-world objects,
+  protocols, devices, etc.  
+
+An |ns3| module may consist of more than one model (for instance, the
+:mod:`internet` model contains models for both TCP and UDP).  In general,
+ns-3 models do not span multiple software modules, however.  
+
+This manual provides documentation about the models of |ns3|.  It 
+complements two other sources of documentation concerning models:
+
+* the model APIs are documented, from a programming perspective, using
+  `Doxygen <http://www.doxygen.org>`_.  Doxygen for ns-3 models is available
+  `on the project web server <http://www.nsnam.org/docs/doxygen/index.html>`_. 
+
+* the |ns3| core is documented in the developer's manual.  |ns3| models make
+  use of the facilities of the core, such as attributes, default values, 
+  random numbers, test frameworks, etc.  Consult the 
+  `main web site <http://www.nsnam.org>`_ to find copies of the manual.
+
+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.
+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:
+
+* 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`.

doc/models/source/replace.txt

@@ -0,0 +1,3 @@
+.. |ns3| replace:: *ns-3*
+
+.. |ns2| replace:: *ns-2*

doc/models/source/routing.rst

@@ -0,0 +1,7 @@
+Routing and Switching
+---------------------
+
+.. toctree::
+
+    click
+    openflow-switch

doc/models/source/support.rst

@@ -0,0 +1,8 @@
+Support
+-------
+
+.. toctree::
+
+   flow-monitor
+   animation
+   statistics

src/click/doc/click.rst

@@ -1,5 +1,5 @@
 Click Modular Router Integration
-----------------------
+--------------------------------
 
 Click is a software architecture for building configurable routers.
 By using different combinations of packet processing units called elements,

src/mpi/doc/distributed.rst

@@ -1,7 +1,7 @@
 .. include:: replace.txt
 
-Distributed
------------
+MPI for Distributed Simulation
+------------------------------
 
 Parallel and distributed discrete event simulation allows the execution of a
 single simulation program on multiple processors. By splitting up the simulation

src/wimax/doc/wimax.h

@@ -291,7 +291,5 @@
  *  SNR_value2   BER  Blc_ER  STANDARD_DEVIATION  CONFIDENCE_INTERVAL1  CONFIDENCE_INTERVAL2
  *  ...          ...  ...     ...                 ...                   ...
  *  ...          ...  ...     ...                 ...                   ...
- * \subsection wimaxl2stack Module Overview
- * \image html WimaxArchitecture.png "Overview of the WiMAX module"
  */