X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/579d27969fbc1fa8004de922816a0068e52a9fa6..390f07ace843ed23ed4d2a1d26f90148d07836ad:/doc/doxygen/module-index.doc diff --git a/doc/doxygen/module-index.doc b/doc/doxygen/module-index.doc index b89f0d6e22..096e81d84d 100644 --- a/doc/doxygen/module-index.doc +++ b/doc/doxygen/module-index.doc @@ -19,7 +19,7 @@ The API enables the declaration of categories and a function to associate them to the tasks (MSG and SD). The tasks that are not classified according to a category are not traced. If no categories are specified, simulations can still be traced using a special -parameter in the command line (see \ref outcomes_vizu for details). +parameter in the command line (see @ref outcomes_vizu for details). */ /** @defgroup ROUTING_API Routing: Determining the communication paths @@ -47,7 +47,7 @@ This is not the way it goes in SimGrid: the network routing is defined in a global and compact way instead. This eases the modeling of very large systems, and allows highly optimized datastructures and algorithms in the simulator. The proposed description mechanism is -thus much more convinient and efficient. In addition, it is more +thus much more convenient and efficient. In addition, it is more expressive than the classical solution based on forwarding tables on each host and router. @@ -55,12 +55,12 @@ The price to pay is that this representation of networks is very specific to SimGrid, so you will have to read further to understand it, even if you already know how real networks work. -The central notion here are \b Networking \b Zones. NetZones represent +The central notion here are @b Networking @b Zones. NetZones represent network areas in which the routing is done in an homogeneous way. Conceptually, netzones generalize from the ideas of local networks (such as Ethernet switched networks) and Autonomous System. The network as a whole is represented as a single hierarchy of netzones, -meaning that every netzone is part of another netzone (but the \c +meaning that every netzone is part of another netzone (but the @c NetRoot, which is the top-level netzone). The main goal of the routing module is to provide a list of links @@ -72,10 +72,10 @@ bypass mechanism. The intra-zone level is naturally handled by the netzones. Each netzone have to specify the routing algorithm it uses for that. -@ref{FullZone} netzones have complete matrix where matrix(a,b) +@ref simgrid::kernel::routing::FullZone "FullZone" netzones have complete matrix where matrix(a,b) represents the full path (the list of links) between the hosts a and -b. @ref{FloydZone} apply the Floyd-Warshall algorithm to compute the -paths. @ref{ClusterZone} model classical switched or hub networks, +b. @ref simgrid::kernel::routing::FloydZone "FloydZone" apply the Floyd-Warshall algorithm to compute the +paths. @ref simgrid::kernel::routing::ClusterZone "ClusterZone" model classical switched or hub networks, where each component is connected through a private link onto a common backbone. Many other routing algorithms are provided to model the classical needs, but you can naturally define your own routing if the @@ -96,24 +96,15 @@ given processes. For now, you can only declare a platform from an XML file, but we are working to make it possible from the C++ code (or even from bindings -in other languages). Until then, please head to \ref platform. +in other languages). Until then, please head to @ref platform. */ -/** \defgroup SIMIX_API SIMIX - \brief POSIX-like interface for building simulation - - This is a developer-level interface that should be useful only if you - plan to design a new interface for SimGrid. -*/ - - - /** @defgroup SURF_API SURF @brief Internal kernel of all the simulators used in SimGrid, and associated models. -SURF provides the core functionnalities to simulate a virtual +SURF provides the core functionalities to simulate a virtual platform. It is very low-level and is not intended to be used by end users, but rather to serve as a basis for higher-level simulators. Its interfaces are not frozen (and probably never will be), and the