remove outdated paragraph in faq

[simgrid.git] / doc / doxygen / module-surf.doc

diff --git a/doc/doxygen/module-surf.doc b/doc/doxygen/module-surf.doc
index 7e3733f..d7e025f 100644 (file)
--- a/doc/doxygen/module-surf.doc
+++ b/doc/doxygen/module-surf.doc
@@ -3,9 +3,8 @@
   \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_interface
    - \ref SURF_cpu_interface
@@ -13,6 +12,7 @@
    - \ref SURF_storage_interface
    - \ref SURF_workstation_interface
    - \ref SURF_vm_workstation_interface
+   - \ref SURF_lmm
    - \ref SURF_callbacks
    - \ref SURF_plugin_energy
    
@@ -23,7 +23,7 @@
     \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.
 */
 
@@ -31,14 +31,14 @@
     \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
@@ -77,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.
 
 */
 
@@ -90,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 <!-- DOXYGEN_NAVBAR_LABEL="Surf Routing" --> @endhtmlonly
+@htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Surf Interface" --> @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 <!-- DOXYGEN_NAVBAR_LABEL="Surf Interface" --> @endhtmlonly
+@htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Surf Routing" --> @endhtmlonly
 */
 
 /**
@@ -167,4 +167,4 @@
 @brief Describes how to use the energy plugin.
 
 @htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Energy plugin" --> @endhtmlonly
-*/
\ No newline at end of file
+*/