-#####################################################################
-########################### CORE ###################################
-#####################################################################
-
/** \addtogroup GRAS_API
-\htmlonly
-<div class="toc">
-<div class="tocTitle">Table of content</div>
-<ol type="1">
-<li> <a href="#GRAS_funct">API documentation</a>
-<li> <a href="#GRAS_example">Examples</a>
-<li> <a href="#GRAS_tut_presentation">Tutorial</a>
-<li> <a href="#GRAS_howto_presentation">HOWTOs</a>
-</div>
-\endhtmlonly
-
- \section GRAS_funct API documentation
- GRAS offers the following functionnalities
+ \section GRAS_funct GRAS offers the following functionnalities
- <b>\ref GRAS_comm</b>: 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
execution time into the simulator and having code sections specific
to simulation or to real mode).
- \section GRAS_example Examples
-
+ \section GRAS_examples Examples
+
There is for now rather few examples of GRAS, but it's better than
nothing, isn't it?
most proeminent one is:
- \ref GRAS_tut_tour_explicitwait_use
-
+
\section GRAS_tut_presentation Tutorial
We even have a tutorial for the GRAS framework. It details in a
- \ref GRAS_tut_tour_explicitwait
- \ref GRAS_tut_tour_message_recaping
- \section GRAS_howto_presentation HOWTOs
+ \section GRAS_howto_presentation HOWTOsbis
The tutorial and the API documentation present the framework little
piece by little piece and provide a lot of information on each of them.
/** @defgroup GRAS_comm Communication facilities */
/** @defgroup GRAS_run Virtualization */
/** @defgroup GRAS_ex Examples */
- /** @defgroup GRAS_tut GRAS Tutorial */
+ /** @defgroup GRAS_tut Tutorial */
/** @} */
#####################################################################
/** @addtogroup GRAS_comm
most proeminent one is:
- \ref GRAS_tut_tour_explicitwait_use
-
- \htmlonly <!--
- DOXYGEN_NAVBAR_CHILD "Ping-Pong"=GRAS_ex_ping.html
- DOXYGEN_NAVBAR_CHILD "RPC"=GRAS_ex_mmrpc.html
- DOXYGEN_NAVBAR_CHILD "Token Ring"=GRAS_ex_token.html
- DOXYGEN_NAVBAR_CHILD "Timers"=GRAS_ex_timer.html
- --> \endhtmlonly
There is some more examples in the distribution, under the directory
<tt>examples/gras</tt>.
#####################################################################
######################### EXAMPLES #################################
#####################################################################
-
---------------------------------------------------------------------
------------------------- Ping Pong ---------------------------------
---------------------------------------------------------------------
-
-/** \page GRAS_ex_ping The classical Ping-Pong in GRAS
+/** @defgroup GRAS_ex_ping Ping-Pong
+ @ingroup GRAS_ex
This example implements the very classical ping-pong in GRAS. It
involves a client (initiating the ping-pong) and a server (answering to
--------------------- Simple Token Ring -----------------------------
---------------------------------------------------------------------
-/** \page GRAS_ex_token Token Ring example
+/** @defgroup GRAS_ex_token Token Ring example
+ @ingroup GRAS_ex
This example implements the token ring algorithm. It involves several
nodes arranged in a ring (each of them have a left and a right neighbour)
-------------------------- MM RPC -----------------------------------
---------------------------------------------------------------------
-/** \page GRAS_ex_mmrpc A simple RPC for matrix multiplication
+/** @defgroup GRAS_ex_mmrpc A simple RPC for matrix multiplication
+ @ingroup GRAS_ex
This example implements a remote matrix multiplication. It involves a client
(creating the matrices and sending the multiplications requests) and a server
\subsection GRAS_ex_mmrpc_serinc 2.a) Server intial settings
All module symbols live in the mmrpc_common.c file. We thus have to
- define \ref GRAS_DEFINE_TYPE_EXTERN to the preprocessor so that the
- \ref GRAS_DEFINE_TYPE symbols don't get included here. Likewise, we use
+ define \ref XBT_DEFINE_TYPE_EXTERN to the preprocessor so that the
+ \ref XBT_DEFINE_TYPE symbols don't get included here. Likewise, we use
\ref XBT_LOG_EXTERNAL_DEFAULT_CATEGORY to get the log category in here.
\dontinclude gras/mmrpc/mmrpc_server.c
---------------------------- Timers ---------------------------------
---------------------------------------------------------------------
-/** \page GRAS_ex_timer Some timer games
+/** @defgroup GRAS_ex_timer Some timer games
+ @ingroup GRAS_ex
This example fools around with the GRAS timers (\ref GRAS_timer). It is
mainly a regression test, since it uses almost all timer features.
