From 6eb760a4e020596621253f11776a99ffd06eff24 Mon Sep 17 00:00:00 2001 From: Frederic Suter Date: Fri, 10 Mar 2017 15:38:02 +0100 Subject: [PATCH] list the new examples in the doc --- examples/s4u/README.doc | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc index f80cb812a9..9cdcf7aae1 100644 --- a/examples/s4u/README.doc +++ b/examples/s4u/README.doc @@ -15,23 +15,32 @@ documentation, but it should remain readable directly. - @ref s4u_ex_basics - @ref s4u_ex_synchro - + @section s4u_ex_basics Basics of SimGrid simulation - - Launching actors - Shows how to start your actors to populate your simulation\n - @ref examples/s4u/launching/s4u_launching.cpp and @ref examples/s4u/launching/deployment.xml + - Launching actors: @ref examples/s4u/launching/s4u_launching.cpp and + @ref examples/s4u/launching/deployment.xml \n + Shows how to start your actors to populate your simulation. + + - Token ring: @ref examples/s4u/app-token-ring/s4u_app-token-ring.cpp \n + Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every + participant. + + - Master Workers: @ref examples/s4u/app-token-ring/s4u_app-token-ring.cpp \n + 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_synchro Inter-Actor Synchronization - - Mutex. - Shows how to use simgrid::s4u::Mutex synchronization objects\n - @ref examples/s4u/mutex/s4u_mutex.cpp - + - Mutex: @ref examples/s4u/mutex/s4u_mutex.cpp \n + Shows how to use simgrid::s4u::Mutex synchronization objects. + */ /** @example examples/s4u/launching/s4u_launching.cpp +@example examples/s4u/app-token-ring/s4u_app-token-ring.cpp +@example examples/s4u/app-master-worker/s4u_app-master-worker.cpp @example examples/s4u/launching/deployment.xml @example examples/s4u/mutex/s4u_mutex.cpp -- 2.20.1