X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/dccf1b41e9c7b5a696f01abceaa2779fe65f154f..5f7494c30c5435f3e21060a2a91d73b8c2e5f45d:/doc/doxygen/uhood_arch.doc
diff --git a/doc/doxygen/uhood_arch.doc b/doc/doxygen/uhood_arch.doc
index db93f20559..f8663f4332 100644
--- a/doc/doxygen/uhood_arch.doc
+++ b/doc/doxygen/uhood_arch.doc
@@ -13,20 +13,20 @@ If you need to extend SimGrid, then you probably need to head to @ref
uhood_tech once you understant the overall design presented on this
page.
-\htmlonly
+@htmlonly
-\endhtmlonly
-\htmlinclude simgrid_modules.map
-\htmlonly
+@endhtmlonly
+@htmlinclude simgrid_modules.map
+@htmlonly
SimGrid Components (click to jump to API)
-\endhtmlonly
+@endhtmlonly
-\section ug_overview Overview of the toolkit components
+@section ug_overview Overview of the toolkit components
-\subsection ug_overview_envs Programing environments layer
+@subsection ug_overview_envs Programing environments layer
SimGrid provides several programming environments built on top of a unique
simulation kernel. Each environment targets a specific audience and
@@ -35,17 +35,17 @@ you have to think about what you want to do and what would be the result of
your work.
- If you want to study a theoretical problem and compare several
- heuristics, you probably want to try \ref MSG_API (yet another
+ heuristics, you probably want to try @ref MSG_API (yet another
historical name). It was designed exactly to that extend and should allow
you to build easily rather realistic multi-agents simulation. Yet,
realism is not the main goal of this environment and the most annoying
- technical issues of real platforms are masked here. Check the \ref
+ technical issues of real platforms are masked here. Check the @ref
MSG_API section for more information.
- If you want to study the behavior of a MPI application using emulation,
- you should have a look at the \ref SMPI_API (Simulated
+ you should have a look at the @ref SMPI_API (Simulated
MPI) programming environment. Unfortunately, this work is still underway.
- Check the \ref SMPI_API section for more information.
+ Check the @ref SMPI_API section for more information.
If your favorite programming environment/model is not there (BSP,
components, OpenMP, etc.) is not represented in the SimGrid toolkit yet, you may
@@ -53,10 +53,10 @@ consider adding it. You should contact us first on the
SimGrid
developers mailing list, though.
-\subsection ug_overview_kernel Simulation kernel layer
+@subsection ug_overview_kernel Simulation kernel layer
The core functionalities to simulate a virtual platform are provided by a
-module called \ref SURF_API. It is
+module called @ref SURF_API. It is
very low-level and is not intended to be used as such by end-users. Instead,
it serve as a basis for the higher level layer.
@@ -64,27 +64,27 @@ SURF main features are a fast max-min linear solver and the ability to
change transparently the model used to describe the platform. This greatly
eases the comparison of the several models existing in the literature.
-See the \ref SURF_API section for more details.
+See the @ref SURF_API section for more details.
-\subsection ug_overview_fundation Base layer
+@subsection ug_overview_fundation Base layer
-The base of the whole toolkit is constituted by the \ref XBT_API
+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.
+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 C data structures:
-\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
+@ref XBT_dynar and @ref XBT_dict.
+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 utilities as well.
-See the \ref XBT_API section for more details.
+See the @ref XBT_API section for more details.
-\subsection ug_lucas_layer Tracing simulation
-Finally, a transversal module allows you to trace your simulation. More documentation in the section \ref TRACE_doc
+@subsection ug_lucas_layer Tracing simulation
+Finally, a transversal module allows you to trace your simulation. More documentation in the section @ref TRACE_doc
*/