very little doc improvement

diff --git a/doc/doxygen/module-s4u.doc b/doc/doxygen/module-s4u.doc
index 213049a..6b8ffa2 100644 (file)
--- a/doc/doxygen/module-s4u.doc
+++ b/doc/doxygen/module-s4u.doc
@@ -12,7 +12,8 @@ SimGrid will be possible in S4U.
 
 Unsurprisingly, the S4U interface matches the concepts presented in 
 @ref starting_components "the introduction". You should read this page
 
 Unsurprisingly, the S4U interface matches the concepts presented in 
 @ref starting_components "the introduction". You should read this page

-first, to not get lost in the amount of classes provided here.
+first, to not get lost in the amount of classes provided here. Or you
+could jump to the \ref s4u_examples directly if you prefer.

 
 @section s4u_raii Memory Management of S4U objects
 
 
 @section s4u_raii Memory Management of S4U objects
 


@@ -20,9 +21,10 @@ For sake of simplicity, we use
 [RAII](https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization)
 everywhere in S4U. This is an idiom where resources are automatically
 managed through the context. Provided that you never manipulate
 [RAII](https://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization)
 everywhere in S4U. This is an idiom where resources are automatically
 managed through the context. Provided that you never manipulate

-objects of type Foo directly but always FooPtr references, you will
-never have to explicitely release the resource that you use nor to
-free the memory of unused objects.
+objects of type Foo directly but always FooPtr references (which are
+[boost::intrusive_ptr](http://www.boost.org/doc/libs/1_61_0/libs/smart_ptr/intrusive_ptr.html)<Foo>),
+you will never have to explicitely release the resource that you use
+nor to free the memory of unused objects.

 
 Here is a little example:
 
 
 Here is a little example:
 

diff --git a/include/simgrid/s4u/conditionVariable.hpp b/include/simgrid/s4u/conditionVariable.hpp
index a32c0b3..973b982 100644 (file)
--- a/include/simgrid/s4u/conditionVariable.hpp
+++ b/include/simgrid/s4u/conditionVariable.hpp
@@ -25,9 +25,10 @@ namespace s4u {
 
 class Mutex;
 
 
 class Mutex;
 

-/** A condition variable
+/** @brief A condition variable
+ *  @ingroup s4u_api

  *
  *

- *  This is based on std::condition_variable and should respect the same
+ *  This is a drop-in replacement of `std::condition_variable` and should respect the same

  *  semantic. But we currently use (only) double for both durations and
  *  timestamp timeouts.
  */
  *  semantic. But we currently use (only) double for both durations and
  *  timestamp timeouts.
  */