checking if a unsigned int is >0 is a bad idea

[simgrid.git] / examples / msg / README.doc

diff --git a/examples/msg/README.doc b/examples/msg/README.doc
index d363311..1687897 100644 (file)
--- a/examples/msg/README.doc
+++ b/examples/msg/README.doc
@@ -2,11 +2,11 @@ This file follows the Doxygen syntax to be included in the
 documentation, but it should remain readable directly.
 
 /** 
- @defgroup MSG_examples MSG examples
+ @defgroup msg_examples MSG examples
  @ingroup MSG_API
  @brief Find the MSG example fitting your needs from the extensive set provided in the archive.
 
-  - @ref msg_ex_basic
+  - @ref msg_ex_basics
   - @ref msg_ex_async
   - @ref msg_ex_process
   - @ref msg_ex_tracing
@@ -18,7 +18,7 @@ documentation, but it should remain readable directly.
   - @ref msg_ex_apps
   - @ref msg_ex_misc
                    
-@section msg_ex_basic Basic examples and features
+@section msg_ex_basics Basic examples and features
 
  - <b>Ping Pong</b>: @ref examples/msg/app-pingpong/app-pingpong.c\n
    It's hard to think of a simpler example: it is just sending one
@@ -38,7 +38,7 @@ documentation, but it should remain readable directly.
    @ref examples/msg/app-masterworker/app-masterworker.c\n
    Another good old example, where one Master process has a bunch of
    task to dispatch to a set of several Worker processes. It is fully
-   commented in @ref MSG_ex_master_worker.
+   commented in @ref msg_ex_master_worker.
 
 @section msg_ex_async Asynchronous communications
 
@@ -60,10 +60,16 @@ shipped in the archive:
    until all activities in a given set have completed.
    
  - <b>Waiting for the first completed communication in a set</b>.
-   @ref examples/msg/async-waitall/async-waitany.c\n
+   @ref examples/msg/async-waitany/async-waitany.c\n
    The @ref MSG_comm_waitany function is useful when you want to block
    until one activity of the set completes, no matter which terminates
    first.
+   
+ - <b>Yielding to other processes</b>.
+   @ref examples/msg/async-yield/async-yield.c\n
+   The @ref MSG_process_yield function interrupts the execution of the
+   current process, leaving a chance to run to the other processes
+   that are ready to run at the exact same timestamp
 
 @section msg_ex_process Acting on Processes
 
@@ -164,10 +170,10 @@ They have to be run with the following options:
 @subsection msg_ex_ns3 NS3 as a SimGrid Network Model
 
 This example demonstrates how to use the bindings to the Network
-Simulator, as explained in @ref pls. The most
+Simulator, as explained in @ref pls_ns3. The most
 interesting is probably not the C files since they are unchanged from
 the other simulations, but the associated files, such as the platform
-file to see how to declare a platform to be used with the PLS bindings
+file to see how to declare a platform to be used with the ns-3 bindings
 of SimGrid and the tesh file to see how to actually start a simulation
 in these settings.
   
@@ -269,14 +275,14 @@ top of the example file).
 
 
 /**
-@defgroup MSG_ex_examples ignored
 @example examples/msg/app-pingpong/app-pingpong.c        
 @example examples/msg/app-token-ring/app-token-ring.c    
 @example examples/msg/app-masterworker/app-masterworker.c
 
 @example examples/msg/async-wait/async-wait.c
 @example examples/msg/async-waitall/async-waitall.c
-@example examples/msg/async-waitall/async-waitany.c
+@example examples/msg/async-waitany/async-waitany.c
+@example examples/msg/async-yield/async-yield.c
 
 @example examples/msg/process-create/process-create.c
 @example examples/msg/process-suspend/process-suspend.c