X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/757ea9f06e8648bf2d3c6582a0c2b6f2ab48ed26..e572880ea8f49be6abcaec9b63dc03c5159a065e:/examples/msg/README.doc diff --git a/examples/msg/README.doc b/examples/msg/README.doc index db0ce0d273..ef998ed57a 100644 --- a/examples/msg/README.doc +++ b/examples/msg/README.doc @@ -2,7 +2,7 @@ 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. @@ -38,12 +38,12 @@ 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 In addition to the fully documented example of @ref -MSG_ex_asynchronous_communications, there are several other examples +msg_ex_asynchronous_communications, there are several other examples shipped in the archive: - Basic asynchronous communications. @@ -60,7 +60,7 @@ shipped in the archive: until all activities in a given set have completed. - Waiting for the first completed communication in a set. - @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. @@ -164,10 +164,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 +269,13 @@ 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/process-create/process-create.c @example examples/msg/process-suspend/process-suspend.c