Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branches 'auto_restart' and 'auto_restart' of framagit.org:simgrid/simgrid
[simgrid.git] / examples / msg / README.doc
index 8d1ef09..53ea4d7 100644 (file)
@@ -1,5 +1,5 @@
-This file follows the Doxygen syntax to be included in the
-documentation, but it should remain readable directly.
+// This file follows the Doxygen syntax to be included in the
+// documentation, but it should remain readable directly.
 
 /** 
  @defgroup msg_examples MSG examples
@@ -13,14 +13,11 @@ documentation, but it should remain readable directly.
   - @ref msg_ex_models
     - @ref msg_ex_ns3
 
-@section msg_ex_basics Basic examples and features
+@warning MSG was deprecated in SimGrid v3.18. These examples should be
+         converted to S4U in the next releases. You really should
+         consider using S4U in your next project.
 
- - <b>Token Ring</b>.
-   @ref examples/msg/app-token-ring/app-token-ring.c\n
-   Classical communication pattern, where a token is exchanged
-   along a ring to reach every participant. 
-   The tesh file laying in the directory shows how to run the same
-   example on different virtual platforms.
+@section msg_ex_basics Basic examples and features
 
  - <b>Master Workers</b>.
    @ref examples/msg/app-masterworker/app-masterworker.c\n
@@ -117,16 +114,15 @@ TODO: show the XML files instead if it's what is interesting. On a "XML example
 
 */
 
-As a human, you can stop reading at this point. The rest is garbage:
-
-Every example must be listed in the following, but it's not possible
-to move this content upper as each @example directive seems to eat
-everything until the next */ marker (and the content is placed at the
-top of the example file). 
+// As a human, you can stop reading at this point. The rest is garbage:
+// 
+// Every example must be listed in the following, but it's not possible
+// to move this content upper as each @example directive seems to eat
+// everything until the next */ marker (and the content is placed at the
+// top of the example file). 
 
 
 /**
-@example examples/msg/app-token-ring/app-token-ring.c
 @example examples/msg/app-masterworker/app-masterworker.c
 
 @example examples/msg/process-create/process-create.c