doxygen/contributing.doc \
doxygen/tracing.doc \
doxygen/FAQ.doc \
- doxygen/modules.doc \
+ doxygen/module-msg.doc \
+ doxygen/module-index.doc \
doxygen/module-xbt.doc \
- doxygen/module-msg.doc \
doxygen/module-sd.doc \
doxygen/module-surf.doc \
doxygen/module-simix.doc \
<tab type="mainpage" visible="yes" title="SimGrid User Documentation" />
- <tab type="usergroup" visible="yes" title="Reference documentation" intro="Reference documentation">
- <tab type="namespaces" visible="no" title="">
- <tab type="namespaces" visible="yes" title="" intro=""/>
- </tab>
- <tab type="examples" visible="yes" title="" intro=""/>
- <tab type="classes" visible="no" title="">
- <tab type="classes" visible="yes" title="" intro=""/>
- <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
- <tab type="hierarchy" visible="yes" title="" intro=""/>
- <tab type="classmembers" visible="no" title="" intro=""/>
- </tab>
- <tab type="modules" visible="no" title="" intro="">
- <tab type="modules" visible="yes" title="APIs Reference"
+ <tab type="modules" visible="yes" title="APIs Reference"
intro="Here is the hierarchical view of all SimGrid modules. You can reduce the amount of detail with the 'detail level' setting, on the right."/>
- </tab>
- </tab>
</navindex>
<!-- Layout definition for a class page -->
<class>
<briefdescription visible="yes"/>
+ <detaileddescription title=""/>
<includes visible="$SHOW_INCLUDE_FILES"/>
<inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
<related title="" subtitle=""/>
<membergroups visible="yes"/>
</memberdecl>
- <detaileddescription title=""/>
<memberdef>
<typedefs title=""/>
<enums title=""/>
+/** \defgroup SD_API SimDag
+ \brief Programming environment for DAG applications
+
+ SimDag provides some functionnalities to simulate parallel task scheduling
+ with DAGs models (Direct Acyclic Graphs).
+ The old versions of SimGrid were based on DAGs. But the DAG part (named SG)
+ was removed in SimGrid 3 because the new kernel (\ref SURF_API) was implemented. \ref SURF_API
+ was much faster and more flexible than SG and did not use DAGs.
+ SimDag is a new implementation of DAGs handling and it is built on top of \ref SURF_API.
+
+ \section SD_who Who should use this (and who shouldn't)
+
+ You should use this programming environment of the SimGrid suite if you want
+ to study algorithms and heuristics with DAGs of parallel tasks.
+ If you don't need to use DAGs for your simulation, have a look at the
+ \ref MSG_API programming environment.
+ If you want to study an existing MPI program, have a look at the
+ \ref SMPI_API one.
+ If none of those programming environments fits your needs, you may
+ consider implementing your own directly on top of \ref SURF_API (but you
+ probably want to contact us before).
+*/
+
+/** \defgroup SMPI_API SMPI
+ \brief Programming environment for the simulation of MPI applications
+*/
+
+
/**
@defgroup XBT_API XBT
@brief The core toolbox of SimGrid, containing usefull datatypes and friends
*/
-/** \defgroup SMPI_API SMPI
- \brief Programming environment for the simulation of MPI applications
-*/
-
-
-/** \defgroup SD_API SimDag
- \brief Programming environment for DAG applications
-
- SimDag provides some functionnalities to simulate parallel task scheduling
- with DAGs models (Direct Acyclic Graphs).
- The old versions of SimGrid were based on DAGs. But the DAG part (named SG)
- was removed in SimGrid 3 because the new kernel (\ref SURF_API) was implemented. \ref SURF_API
- was much faster and more flexible than SG and did not use DAGs.
- SimDag is a new implementation of DAGs handling and it is built on top of \ref SURF_API.
-
- \section SD_who Who should use this (and who shouldn't)
-
- You should use this programming environment of the SimGrid suite if you want
- to study algorithms and heuristics with DAGs of parallel tasks.
- If you don't need to use DAGs for your simulation, have a look at the
- \ref MSG_API programming environment.
- If you want to study an existing MPI program, have a look at the
- \ref SMPI_API one.
- If none of those programming environments fits your needs, you may
- consider implementing your own directly on top of \ref SURF_API (but you
- probably want to contact us before).
-
-*/
/**
@defgroup SURF_API SURF
/**
-@page MSG_API MSG: Simple API for CSP Algorithms
+@defgroup MSG_API MSG: Simple API for CSP Algorithms
@brief Simple programming environment
MSG is a simple API to write algorithms organized with Concurrent
- \ref XBT_set
Data are associated to both an ID (0(1) search) and a name
- \ref XBT_fifo
- - \ref XBT_queue
- \ref XBT_swag
- \ref XBT_heap
- \ref XBT_peer
/** @defgroup XBT_graph General purpose graph library */
/** @defgroup XBT_parmap Parallel map */
/** @defgroup XBT_peer Peer */
- /** @defgroup XBT_queue Queue */
- /** @defgroup XBT_sock Sock */
/** @defgroup XBT_synchro Synchro stuff */
/** @defgroup XBT_thread Thread stuff */
/** @defgroup XBT_context Portable context implementation */
equal to 1.
Of course, you can set any arbitrary filenames you want (so the start and end don't have to be
-in the same file), but be aware that this mechanism only supports \i consecutive calls!
+in the same file), but be aware that this mechanism only supports @em consecutive calls!
\note
Please note that you must pass the \b -trace-call-location flag to smpicc
This section describes the storage management under SimGrid ; nowadays
it's only usable with MSG. It relies basically on linux-like concepts.
You also may want to have a look to its corresponding section in
- @ref msg-file-page ; access functions are organized as a POSIX-like
+ @ref msg_file ; access functions are organized as a POSIX-like
interface.
\subsubsection pf_sto_conc Storage - Main Concepts
SG_BEGIN_DECL()
-/** @addtogroup XBT_file
- * @brief File manipulation functions
+/** @defgroup XBT_file File manipulation functions
+ * @ingroup XBT
*
* This module redefine some quite classical functions such as xbt_getline() or xbt_dirname() for the platforms
* lacking them.
doc/doxygen/module-surf.doc
doc/doxygen/module-trace.doc
doc/doxygen/module-xbt.doc
- doc/doxygen/modules.doc
+ doc/doxygen/module-index.doc
doc/doxygen/options.doc
doc/doxygen/platform.doc
doc/doxygen/pls.doc
