Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics
[simgrid.git] / doc / doxygen / inside.doc
index 19284c0..ded0fa6 100644 (file)
@@ -1,7 +1,6 @@
-/*! @page inside SimGrid Developer Guide
+/*! @page inside Coding Standard and Project Architecture
 
 
-This page does not exist yet, sorry. We are currently refurbishing the
-user documentation -- the internal documentation will follow (FIXME).
+TBD: Coding Standard
 
 There is two main things you want to know about the internals of
 SimGrid. First, you need to understand the component organization, as
 
 There is two main things you want to know about the internals of
 SimGrid. First, you need to understand the component organization, as
@@ -79,9 +78,14 @@ The base of the whole toolkit is constituted by the <b>\ref XBT_API
 (eXtended Bundle of Tools)</b>.
 
 It is a portable library providing some grounding features such as \ref
 (eXtended Bundle of Tools)</b>.
 
 It is a portable library providing some grounding features such as \ref
-XBT_log, \ref XBT_ex and \ref XBT_config. XBT also encompass
-the following convenient datastructures: \ref XBT_dynar, \ref XBT_fifo, \ref
-XBT_dict, \ref XBT_heap, \ref XBT_set and \ref XBT_swag.
+XBT_log, \ref XBT_ex and \ref XBT_config.
+
+XBT also encompass the following convenient C datastructures:
+\ref XBT_dynar, \ref XBT_fifo, \ref XBT_dict, \ref XBT_heap, \ref XBT_set and
+\ref XBT_swag. The code is being migrated in C++ so you should probably want
+to use standard C++ containers instead of them if possible.
+
+It contains some C++ polyfills and utilies as well.
 
 See the \ref XBT_API section for more details.
 
 
 See the \ref XBT_API section for more details.