New function: gras_msg_wait_ext (for a finer control of accepted messages); introduce...

[simgrid.git] / doc / module-gras.doc

diff --git a/doc/module-gras.doc b/doc/module-gras.doc
index a43fec7..a6e54bb 100644 (file)
--- a/doc/module-gras.doc
+++ b/doc/module-gras.doc
@@ -75,7 +75,10 @@
 
 /** \page GRAS_main_generation main() and GRAS
 
-    <center>[\ref GRAS_API]</center>
+  <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref GRAS_API]
+                 <tr><td><b>Prev</b>   <td> [\ref GRAS_emul]
+                 <tr><td><b>Next</b>   <td> [\ref GRAS_compile]            </table></center>
+
 
     \section GRAS_maingen_toc Table of content
      
@@ -153,7 +156,9 @@
 
 /** \page GRAS_compile Compiling your GRAS project
 
-    <center>[\ref GRAS_API]</center>
+    <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref GRAS_API]
+                   <tr><td><b>Prev</b>   <td> [\ref GRAS_main_generation]
+                   <tr><td><b>Next</b>   <td> [\ref GRAS_ex_ping]            </table></center>
 
     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
 
-    <center>[\ref GRAS_API]</center>
+    <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref GRAS_API]
+                   <tr><td><b>Prev</b>   <td> [\ref GRAS_compile]
+                   <tr><td><b>Next</b>   <td> [\ref GRAS_ex_mmrpc]            </table></center>
 
     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
 
-    <center>[\ref GRAS_API]</center>
+    <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref GRAS_API]
+                   <tr><td><b>Prev</b>   <td> [\ref GRAS_ex_ping]
+                   <tr><td><b>Next</b>   <td> [\ref GRAS_ex_timer]            </table></center>
 
     This example implements a remote matrix multiplication. It involves a client 
     (creating the matrices and sending the multiplications requests) and a server 
@@ -407,7 +416,7 @@
 
     The messages involved in this example do use structures as payload, 
     so we have to declare it to GRAS. Hopefully, this can be done easily by enclosing 
-    the structure declaration within a GRAS_DEFINE macro call. It will then copy this 
+    the structure declaration within a \ref GRAS_DEFINE_TYPE macro call. It will then copy this 
     declaration into an hidden string variable, which can be automatically parsed at 
     run time. Of course, the declaration is also copied unmodified by this macro, so that it
     gets parsed by the compiler also. 
@@ -424,14 +433,14 @@
     imply. If you want to use it yourself, you'd better use the exact right syntax, which is 
     detailed in the \ref GRAS_dd section.
 
-    \skip GRAS_DEFINE
+    \skip GRAS_DEFINE_TYPE
     \until matrix_t
 
     \subsection GRAS_ex_mmrpc_msgregister 1.c) Register the messages
     
     This function, called by both the client and the server is in charge of
     declaring the existing messages to GRAS. Note the use of the \ref gras_datadesc_by_symbol 
-    function to parse and retrieve the structure declaration which were passed to \ref GRAS_DEFINE 
+    function to parse and retrieve the structure declaration which were passed to \ref GRAS_DEFINE_TYPE 
     above. 
 
     The datatype description builded that way can then be used to build an array datatype or 
@@ -486,7 +495,9 @@
 
 /** \page GRAS_ex_timer Some timer games
 
-    <center>[\ref GRAS_API]</center>
+    <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref GRAS_API]
+                   <tr><td><b>Prev</b>   <td> [\ref GRAS_ex_mmrpc]
+                   <tr><td>   Next       <td>            </table></center>
 
     This example fools around with the GRAS timers (\ref GRAS_timer). It is
     mainly a regression test, since it uses almost all timer features.