From: Martin Quinson <martin.quinson@loria.fr>
Date: Mon, 4 Dec 2017 22:08:05 +0000 (+0100)
Subject: small doc improvement (noci)
X-Git-Tag: v3.18~164^2
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/89c27c5a66e26449313a876fee38b0da80a56727

small doc improvement (noci)
---

diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc
index a19f8747af..26c5b7f0e0 100644
--- a/examples/s4u/README.doc
+++ b/examples/s4u/README.doc
@@ -18,6 +18,8 @@ documentation, but it should remain readable directly.
   - @ref s4u_ex_actors
   - @ref s4u_ex_synchro
   - @ref s4u_ex_actions
+  - @ref s4u_ex_io
+  - @ref s4u_ex_energy
 
 @section s4u_ex_basics Basics of SimGrid simulation
 
@@ -82,7 +84,7 @@ documentation, but it should remain readable directly.
     Actors can be suspended and resumed during their executions
     thanks to the @ref suspend and @ref resume methods.
 
-    - <b>Priority actors</b>.
+  - <b>Priority actors</b>.
     @ref examples/s4u/actor-priority/s4u-actor-priority.cpp \n
     Actors can be launched according their priorities thanks to the @ref
      execution method.
@@ -101,12 +103,6 @@ documentation, but it should remain readable directly.
     @ref examples/s4u/actor-migration/s4u-actor-migration.cpp \n
     Actors can move or be moved from a host to another with the @ref migrate method.
 
-  - <b>Using Pstates on a host</b>
-    @ref examples/s4u/energy-pstate/s4u-energy-pstate.cpp\n
-    Show how define a set of pstates for a host and how the current
-    pstate can be accessed/changed with @ref getPstateSpeed and @ref  sg_host_set_pstate.
-    See also the platform XML file for have a details on how to declare the CPU capacity for each pstate.
-
   - <b>Yielding to other actor</b>.
     @ref examples/s4u/actor-yield/s4u-actor-yield.c\n
     The simgrid::s4u::this_actor::yield() function interrupts the
@@ -146,7 +142,7 @@ also the tesh files in the example directories for details.
     Presents a set of event handlers reproducing classical I/O
     primitives (open, read, close).
 
-@subsection s4u_ex_io Simulating disks and files
+@section s4u_ex_io Simulating disks and files
 
 The examples of this section demonstrate how to interact with the
 simulated storages.
@@ -161,6 +157,15 @@ simulated storages.
     I/O operations on files can also be done in a remote fashion, 
     i.e. when the accessed disk is not mounted on the caller's host.
 
+@section s4u_ex_energy Simulating the energy consumption
+
+  - <b>Using Pstates on a host</b>
+    @ref examples/s4u/energy-pstate/s4u-energy-pstate.cpp and 
+    @ref examples/platforms/energy_platform.xml \n
+    Show how define a set of pstates for a host and how the current
+    pstate can be accessed/changed with @ref getPstateSpeed and @ref sg_host_set_pstate.
+    See also the platform XML file for have a details on how to declare the CPU capacity for each pstate.
+
 */
 
 /**
@@ -179,6 +184,7 @@ simulated storages.
 @example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
 @example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
 @example examples/s4u/energy-pstate/s4u-energy-pstate.cpp
+@example examples/platforms/energy_platform.xml
 @example examples/s4u/io-file-remote/s4u-io-file-remote.cpp
 @example examples/s4u/io-raw-storage/s4u-io-raw-storage.cpp
 @example examples/s4u/mutex/s4u-mutex.cpp
diff --git a/examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp b/examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
index 8f2b4eca25..9ec2753700 100644
--- a/examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
+++ b/examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp
@@ -3,6 +3,9 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
+/* This C++ file acts as the foil to the corresponding XML file, where the
+   action takes place: Actors are started and stopped at predefined time.   */
+
 #include "simgrid/s4u.hpp"
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(test, "Messages specific for this s4u example");