Let's run amok

git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@1443 48e7efb5-ca39-0410-a469-dd3cf9ba447f

diff --git a/doc/module-amok.doc b/doc/module-amok.doc
new file mode 100644 (file)
index 0000000..852dce9
--- /dev/null
+++ b/doc/module-amok.doc
@@ -0,0 +1,19 @@
+#####################################################################
+###########################  CORE ###################################
+#####################################################################
+
+/** \addtogroup AMOK_API
+ * 
+ *  @{ */     
+
+       /** \defgroup AMOK_bw      Bandwidth      */       
+
+/** @} */
+
+#####################################################################
+#########################  EXTRA PAGES ##############################
+#####################################################################
+
+#####################################################################
+#########################  EXAMPLES #################################
+#####################################################################

diff --git a/doc/modules.doc b/doc/modules.doc
index b57cbb6..ae955eb 100644 (file)
--- a/doc/modules.doc
+++ b/doc/modules.doc
@@ -1,5 +1,5 @@
 /** 
 /** 

-  \defgroup SimGrid_API  API of SimGrid */
+  \defgroup SimGrid_API  SimGrid modules */

 
 /** \defgroup XBT_API      XBT
        \ingroup SimGrid_API
 
 /** \defgroup XBT_API      XBT
        \ingroup SimGrid_API


@@ -49,7 +49,7 @@
     \ingroup SimGrid_API
     \brief Realistic programming environment (Grid Reality And Simulation)
   
     \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
     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


@@ -75,6 +75,17 @@
     probably want to contact us before).
 */
 
     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
 /** \defgroup SMPI_API      SMPI
     \ingroup SimGrid_API
     \brief Programming environment for the simulation of MPI applications