Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Also display the pid on backtraces
[simgrid.git] / doc / modules.doc
index b57cbb6..23e30d6 100644 (file)
@@ -1,10 +1,11 @@
 /** 
-  \defgroup SimGrid_API  API of SimGrid */
+  \defgroup SimGrid_API  SimGrid modules */
 
 /** \defgroup XBT_API      XBT
-       \ingroup SimGrid_API
-       \brief The core toolbox of SimGrid, containing usefull datatypes,
-       portability support and so on.
+    \ingroup SimGrid_API
+    \brief The core toolbox of SimGrid, containing usefull datatypes,
+           portability support and so on.
+
 */
 
 /** \defgroup SURF_API       SURF
@@ -35,7 +36,7 @@
 
       \section MSG_who Who should use this (and who shouldn't)
       
-      You should use this model if you want to study some heuristics for a
+      You should use this module if you want to study some heuristics for a
       given problem you don't really want to implement. If you want to get a
       real implementation of your solution, have a look at the \ref GRAS_API 
       programming environment. If you want to study an existing MPI program,
@@ -49,7 +50,7 @@
     \ingroup SimGrid_API
     \brief Realistic programming environment (Grid Reality And Simulation)
   
-    GRAS provide a complete API to implement distributed application on top
+    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
     comfort of the simulator), an implementation suited to real platforms is
     probably want to contact us before).
 */
 
+/** \defgroup AMOK_API AMOK
+    \ingroup SimGrid_API
+    \brief Distributed toolkit built over \ref GRAS_API (Advanced Metacomputing Overlay Kit)
+
+    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
+    run time. For now, they live in another library against which you should link your 
+    programs explicitly.
+*/
+
 /** \defgroup SMPI_API      SMPI
     \ingroup SimGrid_API
     \brief Programming environment for the simulation of MPI applications