From: mquinson Date: Sat, 22 Oct 2005 11:40:09 +0000 (+0000) Subject: Add navigation bar in the documentation (of GRAS) X-Git-Tag: v3.3~3568 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/5db520d83cf2b68f786439ff7ff3e30dbb40e789?hp=eed8daedf7c2d58e0db96826205f138cedb9cc5a Add navigation bar in the documentation (of GRAS) git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@1790 48e7efb5-ca39-0410-a469-dd3cf9ba447f --- diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 9e622f9590..ba77b1a118 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -644,7 +644,7 @@ BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. -TOC_EXPAND = NO +TOC_EXPAND = YES # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and diff --git a/doc/module-gras.doc b/doc/module-gras.doc index 1e0819294a..a6e54bb60f 100644 --- a/doc/module-gras.doc +++ b/doc/module-gras.doc @@ -75,7 +75,10 @@ /** \page GRAS_main_generation main() and GRAS -
[\ref GRAS_API]
+
Top [\ref index]::[\ref GRAS_API] +
Prev [\ref GRAS_emul] +
Next [\ref GRAS_compile]
+ \section GRAS_maingen_toc Table of content @@ -153,7 +156,9 @@ /** \page GRAS_compile Compiling your GRAS project -
[\ref GRAS_API]
+
Top [\ref index]::[\ref GRAS_API] +
Prev [\ref GRAS_main_generation] +
Next [\ref GRAS_ex_ping]
As explained in section \ref GRAS_main_generation, the gras_stub_generator tool can be used to generate the system @@ -251,7 +256,9 @@ /** \page GRAS_ex_ping The classical Ping-Pong in GRAS -
[\ref GRAS_API]
+
Top [\ref index]::[\ref GRAS_API] +
Prev [\ref GRAS_compile] +
Next [\ref GRAS_ex_mmrpc]
This example implements the very classical ping-pong in GRAS. It involves a client (initiating the ping-pong) and a server (answering to @@ -357,7 +364,9 @@ /** \page GRAS_ex_mmrpc A simple RPC for matrix multiplication -
[\ref GRAS_API]
+
Top [\ref index]::[\ref GRAS_API] +
Prev [\ref GRAS_ex_ping] +
Next [\ref GRAS_ex_timer]
This example implements a remote matrix multiplication. It involves a client (creating the matrices and sending the multiplications requests) and a server @@ -486,7 +495,9 @@ /** \page GRAS_ex_timer Some timer games -
[\ref GRAS_API]
+
Top [\ref index]::[\ref GRAS_API] +
Prev [\ref GRAS_ex_mmrpc] +
Next
This example fools around with the GRAS timers (\ref GRAS_timer). It is mainly a regression test, since it uses almost all timer features. diff --git a/doc/modules.doc b/doc/modules.doc index fede18e5ce..79a4cf549e 100644 --- a/doc/modules.doc +++ b/doc/modules.doc @@ -6,6 +6,8 @@ \brief The core toolbox of SimGrid, containing usefull datatypes, portability support and so on. +
Top [\ref index] +
Other modules [\ref SURF_API] [\ref MSG_API] [\ref GRAS_API] [\ref AMOK_API] [\ref SMPI_API]
*/ @@ -13,6 +15,10 @@ \ingroup SimGrid_API \brief Kernel of all the simulators used in SimGrid, and associated models. +
Top [\ref index] +
Related modules [\ref XBT_API] +
Other modules [\ref MSG_API] [\ref GRAS_API] [\ref AMOK_API] [\ref SMPI_API]
+ SURF provides the core functionnalities to simulate a virtual platform. It is very low-level and is not intended to be used as such but rather to serve as a basis for higher-level simulators. @@ -32,6 +38,10 @@ \ingroup SimGrid_API \brief Simple programming environment +
Top [\ref index] +
Related modules [\ref XBT_API] +
Other modules [\ref SURF_API] [\ref GRAS_API] [\ref AMOK_API] [\ref SMPI_API]
+ MSG was the first distributed programming environment provided within SimGrid. While almost realistic, it remains quite simple (simplistic?). @@ -51,6 +61,11 @@ \ingroup SimGrid_API \brief Realistic programming environment (Grid Reality And Simulation) +
Top [\ref index] +
Related modules [\ref XBT_API] [\ref AMOK_API] +
Other modules [\ref SURF_API] [\ref MSG_API] [\ref SMPI_API] +
Down [\ref GRAS_dd]
+ GRAS provides a complete API to implement distributed application on top of heterogeneous plateforms. In addition to the SimGrid implementation of this interface (allowing you to work on your application within the @@ -81,6 +96,10 @@ \ingroup SimGrid_API \brief Distributed toolkit built over \ref GRAS_API (Advanced Metacomputing Overlay Kit) +
Top [\ref index] +
Related modules [\ref XBT_API] [\ref GRAS_API] +
Other modules [\ref SURF_API] [\ref MSG_API] [\ref SMPI_API]
+ AMOK provides several tools useful to most applications built on top of GRAS, but yet not belonging to GRAS itself. It is planned that those modules will be changed to real plugins one day, allowing users to load only the needed parts at @@ -92,6 +111,10 @@ \ingroup SimGrid_API \brief Programming environment for the simulation of MPI applications +
Top [\ref index] +
Related modules [\ref XBT_API] +
Other modules [\ref SURF_API] [\ref GRAS_API] [\ref AMOK_API] [\ref MSG_API]
+ Once implemented, this programming environment will allow you to study within the simulator any MPI application without having to modify them for that. In other words, it will constitute an emulation solution for