Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add a new function: MSG_task_get_with_timeout. That should be very convenient to...
[simgrid.git] / doc / modules.doc
index 40ea7f2..ae955eb 100644 (file)
@@ -1,5 +1,5 @@
 /** 
-  \defgroup SimGrid_API  API of SimGrid */
+  \defgroup SimGrid_API  SimGrid modules */
 
 /** \defgroup XBT_API      XBT
        \ingroup SimGrid_API
       directly on top of \ref SURF_API (but you probably want to contact us
       before). 
 */
-/**     \addtogroup m_datatypes_management
-        \ingroup MSG_API  */
-/**     \addtogroup m_process_management
-        \ingroup MSG_API  */
-/**     \addtogroup m_host_management
-        \ingroup MSG_API  */
-/**     \addtogroup m_task_management
-        \ingroup MSG_API  */
-/**     \addtogroup msg_gos_functions
-        \ingroup MSG_API  */
-/**     \addtogroup m_channel_management
-        \ingroup MSG_API  */
-/**     \addtogroup msg_easier_life
-        \ingroup MSG_API  */
-/**     \addtogroup msg_simulation
-        \ingroup MSG_API  */
-
 
 /** \defgroup GRAS_API      GRAS
     \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