X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b37de5b1f318c86019b809ad525a306ffd5755fd..f5336306d4e4bfc2c0bd979bbb4cb875fa922a4a:/doc/doxygen/module-surf.doc diff --git a/doc/doxygen/module-surf.doc b/doc/doxygen/module-surf.doc index 77e26065ec..d7e025fcec 100644 --- a/doc/doxygen/module-surf.doc +++ b/doc/doxygen/module-surf.doc @@ -3,16 +3,16 @@ \section SURF_doc Surf documentation Surf is composed several components: - \ref SURF_simulation - - \ref SURF_actions - - \ref SURF_resources - \ref SURF_build_api + - \ref SURF_c_bindings - \ref SURF_interface - - \ref SURF_routing + - \ref SURF_routing_interface - \ref SURF_cpu_interface - \ref SURF_network_interface - \ref SURF_storage_interface - \ref SURF_workstation_interface - \ref SURF_vm_workstation_interface + - \ref SURF_lmm - \ref SURF_callbacks - \ref SURF_plugin_energy @@ -23,36 +23,22 @@ \ingroup SURF_API \brief Functions for creating the environment and launching the simulation - This section describes the functions for initialising SURF, performing + This section describes the functions for initializing SURF, performing the simulation and exiting SURF. */ -/** \defgroup SURF_actions SURF actions - \ingroup SURF_API - \brief This section describes the different datatypes and operations related to the actions in SURF. - - \htmlonly \endhtmlonly -*/ - -/** \defgroup SURF_resources SURF resources - \ingroup SURF_API - \brief This section describes the different datatypes and operations related to the resources in SURF. - - \htmlonly \endhtmlonly -*/ - /** \defgroup SURF_build_api Create a new API \ingroup SURF_API \brief How to build a new API on top of SURF - SURF provides the functionnalities to simulate the platform. There are two main datatypes in SURF: + SURF provides the functionalities to simulate the platform. There are two main data types in SURF: the actions and the resources. Several types of resources exist: - the workstation resource, - the network resource, - the CPU resource, - the timer resource. - The implentation of these resources depends on the platform model you choose. There are several + The implementation of these resources depends on the platform model you choose. There are several platform models. You can select your model by calling surf_workstation_resource_init_CLM03() or surf_workstation_resource_init_KCCFLN05(). See the documentation of these functions to have more details about the models. Remember that the model KCCFLN05 is an implementation of both the @@ -91,7 +77,7 @@ Have a look at the implementation of \ref MSG_API "MSG" and \ref SD_API "Simdag" to see how these module interact with SURF. But if you want to create a new API on top of SURF, - we strongly recommand you to contact us before anyway. + we strongly recommend you to contact us before anyway. */ @@ -104,19 +90,19 @@ */ /** -@defgroup SURF_routing_interface SURF Routing Interface +@defgroup SURF_interface SURF Interface @ingroup SURF_API -@brief Describes the routing interface +@brief Describes the general interface for all components (Cpu, Network, Storage, Workstation, WorkstationVM) -@htmlonly @endhtmlonly +@htmlonly @endhtmlonly */ /** -@defgroup SURF_interface SURF Interface +@defgroup SURF_routing_interface SURF Routing Interface @ingroup SURF_API -@brief Describes the general interface for all components (Cpu, Network, Storage, Workstation, WorkstationVM) +@brief Describes the routing interface -@htmlonly @endhtmlonly +@htmlonly @endhtmlonly */ /** @@ -181,4 +167,4 @@ @brief Describes how to use the energy plugin. @htmlonly @endhtmlonly -*/ \ No newline at end of file +*/