examples/s4u/README.doc

   1 S4U (Simgrid for you) is the next interface of SimGrid, expected to be released with SimGrid 4.0.
   2
   3 Even if it's in a very preliminary state so far, you are welcome to
   4 try it and report any interface glitches that you see. Be however
   5 warned that the interface will be modified until its final release.
   6 You will have to adapt your code on the way.
   7
   8 This file follows the Doxygen syntax to be included in the
   9 documentation, but it should remain readable directly.
  10
  11 /**
  12  @defgroup s4u_examples S4U examples
  13  @ingroup s4u_api
  14  @brief Find the S4U example fitting your needs in the archive.
  15
  16   - @ref s4u_ex_basics
  17   - @ref s4u_ex_synchro
  18
  19 @section s4u_ex_basics Basics of SimGrid simulation
  20
  21   - <b>Launching actors</b>
  22     Shows how to start your actors to populate your simulation\n
  23     @ref examples/s4u/launching/s4u_launching.cpp and @ref examples/s4u/launching/deployment.xml
  24
  25 @section s4u_ex_synchro Inter-Actor Synchronization
  26
  27  - <b>Mutex.</b>
  28    Shows how to use simgrid::s4u::Mutex synchronization objects\n
  29    @ref examples/s4u/mutex/s4u_mutex.cpp
  30
  31 */
  32
  33 /**
  34 @example examples/s4u/launching/s4u_launching.cpp
  35 @example examples/s4u/launching/deployment.xml
  36
  37 @example examples/s4u/mutex/s4u_mutex.cpp
  38
  39 */