X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/cf108868b4eeed4d0d9d343bc68557d7814e18c0..8b5379a334016329aaa0dcb20a9c421bc997bff3:/doc/doxygen/inside.doc diff --git a/doc/doxygen/inside.doc b/doc/doxygen/inside.doc index 0cdb36e7b3..ded0fa6695 100644 --- a/doc/doxygen/inside.doc +++ b/doc/doxygen/inside.doc @@ -1,12 +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). - -All we can say for now is that once you learn a bit about the SimGrid -internals, you will probably look a bit like this: - -@image html DiscoveringSimgrid.gif Discovering SimGrid's Internals. +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 @@ -84,9 +78,14 @@ The base of the whole toolkit is constituted by the \ref XBT_API (eXtended Bundle of Tools). 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.