X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1ad68dab15ca87309f47ce7e3e0d3d0624ac4e1c..92661d62eaee255e5f677a667c0f05a4f5917c24:/doc/doxygen/examples.doc diff --git a/doc/doxygen/examples.doc b/doc/doxygen/examples.doc index 9df25cbe3d..8718864768 100644 --- a/doc/doxygen/examples.doc +++ b/doc/doxygen/examples.doc @@ -1,14 +1,9 @@ /*! \page examples SimGrid Examples -\note - This page is under work -- sorry for the inconvenience (FIXME). - -- @ref help - \tableofcontents SimGrid comes with many examples provided in the examples/ directory. -Those examples are described in section \ref MSG_examples. Those +Those examples are described in section \ref msg_examples. Those examples are commented and should be easy to understand. for a first step into SimGrid we also provide some more detailed examples in the sections below. @@ -138,7 +133,7 @@ an external description of the deployment. \paragraph MSG_ext_async_Sender Sender function -A host can send an asynchronous message with \c MSG_task_isend(). %As this function is non-blocking, we have to call +A host can send an asynchronous message with \c MSG_task_isend(). As this function is non-blocking, we have to call \c MSG_comm_test() to know if the communication is complete and evenetually destroy it with a call to \c MSG_comm_destroy(). It is also possible to call \c MSG_comm_wait() which provides a shortcut. @@ -155,7 +150,7 @@ A host can send an asynchronous message with \c MSG_task_isend(). %As this funct \paragraph MSG_ext_async_Receiver Receiver function -This function executes tasks when it receives them. %As the receiving is asynchronous, we have to test the completion of +This function executes tasks when it receives them. As the receiving is asynchronous, we have to test the completion of the communication with \c MSG_comm_test() or wait for it with \c MSG_comm_wait(). C style arguments (argc/argv) are interpreted as: