X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/fe8f0007bbd37e5e104fda886ff613276082e4f9..bb8f33bb835251a993421cbef4b9f8601e20eb0a:/doc/module-gras.doc
diff --git a/doc/module-gras.doc b/doc/module-gras.doc
index c653142c9e..c91622e8a0 100644
--- a/doc/module-gras.doc
+++ b/doc/module-gras.doc
@@ -3,8 +3,20 @@
#####################################################################
/** \addtogroup GRAS_API
-
- \section GRAS_funct Offered functionnalities
+
+\htmlonly
+
+\endhtmlonly
+
+ \section GRAS_funct API documentation
+ GRAS offers the following functionnalities
- \ref GRAS_comm: Exchanging messages between peers
- \ref GRAS_dd : any data which may transit on the network must be
described beforehand so that GRAS can handle the platform
@@ -41,11 +53,20 @@
- \ref GRAS_ex_mmrpc
- \ref GRAS_ex_token
- \ref GRAS_ex_timer
+
+ The initiatic tour of the tutorial also contains several examples. The
+ most proeminent one is:
+
+ - \ref GRAS_tut_tour_explicitwait_use
\section GRAS_tut_presentation Tutorial
- We even have a tutorial for the GRAS framework. Here is the table of
+ We even have a tutorial for the GRAS framework. It details in a
+ hopefully pedagogic order all the points of the API, along with example
+ of use for each of them. Unfortunately, it is not finished yet (the main
+ part missing is the one on how to describe data). Here is the table of
content:
+
- \ref GRAS_tut_intro
- \ref GRAS_tut_intro_what
- \ref GRAS_tut_intro_model
@@ -60,6 +81,19 @@
- \ref GRAS_tut_tour_timers
- \ref GRAS_tut_tour_exceptions
- \ref GRAS_tut_tour_rpc
+ - \ref GRAS_tut_tour_explicitwait
+ - \ref GRAS_tut_tour_message_recaping
+
+ \section GRAS_howto_presentation HOWTOs
+
+ The tutorial and the API documentation present the framework little
+ piece by little piece and provide a lot of information on each of them.
+ Quite orthogonally to this, the HOWTOs try to present transversal
+ aspects of the framework to give you some broader point of view on it.
+ How infortunate it is that only one such HOWTO exist for now...
+
+ - \ref GRAS_howto
+ - \ref GRAS_howto_design
@{ */
/** @defgroup GRAS_comm Communication facilities */
@@ -112,6 +146,11 @@
- \ref GRAS_ex_token
- \ref GRAS_ex_timer
+ The initiatic tour of the tutorial also contains several examples. The
+ most proeminent one is:
+
+ - \ref GRAS_tut_tour_explicitwait_use
+
\htmlonly