Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doxygen: uniformity in command markers (@ vs. \)
[simgrid.git] / doc / doxygen / module-s4u.doc
index abd1c3c..8b70f03 100644 (file)
@@ -1,21 +1,21 @@
 /**
-@defgroup s4u_api  S4U: Next Generation SimGrid API
+@defgroup s4u_api  S4U: Next generation SimGrid API
 @brief Future core API, mixing the full power of SimGrid to the power of C++. 
 
-The S4U API is currently under heavy work, but will eventually
-deprecate the MSG and SimDag APIs. Everything that you can do in
-SimGrid will be possible in S4U. 
+The S4U API is near from its final state.  Everything that you can do in
+SimGrid should be possible in S4U and the missing pieces are seen as
+bugs.
 
-@warning <b>S4U is not as rock stable as the rest of SimGrid yet</b>. 
-        You are really welcome to test it, but be warned that the API
-        may change without notice between releases. This is however
-        the way to go if you want to create a new long-term project.
-        If you want to play safe, proceed to @ref MSG_API instead. 
+@warning <b>S4U is still evolving: v3.18 is a beta release</b>. You
+        are really welcome to test it, but this API may change
+        between releases. This is however the way to go if you want
+        to create a new long-term project. If you want to play safe,
+        proceed to deprecated @ref MSG_API instead. 
 
 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. Or you
-could jump to the \ref s4u_examples directly if you prefer.
+could jump to the @ref s4u_examples directly if you prefer.
 
 @section s4u_raii Memory Management of S4U objects