From: Martin Quinson Date: Sat, 9 Dec 2017 16:34:18 +0000 (+0100) Subject: doc improvement X-Git-Tag: v3.18~74 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/140813f2b6c9264b534ddea3f7de3a80a5591924 doc improvement --- diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc index 6ab9071d83..8828fe5885 100644 --- a/examples/s4u/README.doc +++ b/examples/s4u/README.doc @@ -14,7 +14,7 @@ documentation, but it should remain readable directly. @brief Find the S4U example fitting your needs in the archive. - @ref s4u_ex_basics - - @ref s4u_ex_async + - @ref s4u_ex_activities - @ref s4u_ex_actors - @ref s4u_ex_synchro - @ref s4u_ex_actions @@ -43,7 +43,9 @@ TODO: document here the examples about plugins Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker processes. -@section s4u_ex_async Asynchronous communications +@section s4u_ex_activities Activities on Resources (communications and executions) + +@subsection s4u_ex_activity_comm Communications (using the network) - Basic asynchronous communications. @ref examples/s4u/async-wait/s4u-async-wait.cpp \n @@ -64,14 +66,9 @@ TODO: document here the examples about plugins until one activity of the set completes, no matter which terminates first. -@section s4u_ex_actors Acting on Actors - - - Creating actors. - @ref examples/s4u/actor-create/s4u-actor-create.cpp \n - Most actors are started from the deployment XML file, but there is other methods. - This example show them all. +@subsection s4u_ex_activity_exec Executions (using the CPU) - - Actors using CPU time. + - Basic execution. @ref examples/s4u/actor-execute/s4u-actor-execute.cpp \n The computations done in your program are not reported to the simulated world, unless you explicitely request the simulator to pause @@ -79,6 +76,13 @@ TODO: document here the examples about plugins host. Some executions can be given an higher priority so that they get more resources. +@section s4u_ex_actors Acting on Actors + + - Creating actors. + @ref examples/s4u/actor-create/s4u-actor-create.cpp \n + Most actors are started from the deployment XML file, but there is other methods. + This example show them all. + - Daemonize actors @ref examples/s4u/actor-daemon/s4u-actor-daemon.cpp \n Some actors may be intended to simulate daemons that run in background. This example show how to transform a regular