From 41c62223ee852b2eb96dad8abee5c9ade330f980 Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Thu, 15 Oct 2009 15:59:52 -0700 Subject: [PATCH] add figure for manual overview --- doc/manual/Makefile | 1 + doc/manual/organization.texi | 9 +++++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/manual/Makefile b/doc/manual/Makefile index 2f27bfb86..04e7cb439 100644 --- a/doc/manual/Makefile +++ b/doc/manual/Makefile @@ -17,6 +17,7 @@ IMAGES_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 \ diff --git a/doc/manual/organization.texi b/doc/manual/organization.texi index 78a2ade05..b62c4d83d 100644 --- a/doc/manual/organization.texi +++ b/doc/manual/organization.texi @@ -12,8 +12,13 @@ defines the simulation topology and starts the simulator. ns-3 also exports nearly all of its API to Python, allowing Python programs to import an "ns3" module in much the same way as in C++. +@float Figure,fig:organization +@caption{Software organization of ns-3} +@center @image{figures/software-organization, 5in} +@end float + The source code for ns-3 is mostly organized in the @code{src/} -directory and can be described by the following block diagram. +directory and can be described by the diagram in @ref{fig:organization}. We will work our way from the bottom up; in general, modules only have dependencies on modules beneath them in the figure. @@ -47,4 +52,4 @@ Part 6 describes additional support for simulation, such as animators. The project maintains a separate manual devoted to testing and validation of ns-3 code (see the -@uref{http://www.nsnam.org/docs,, ns-3 Testing and Validation manual})j +@uref{http://www.nsnam.org/tutorials.html,, ns-3 Testing and Validation manual})j