Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
update surf doc to kill some more doc warnings
authorMartin Quinson <martin.quinson@loria.fr>
Tue, 20 Mar 2012 16:15:51 +0000 (17:15 +0100)
committerMartin Quinson <martin.quinson@loria.fr>
Tue, 20 Mar 2012 16:15:51 +0000 (17:15 +0100)
doc/module-surf.doc
src/surf/surf_routing.c

index a870b88..a0a9bba 100644 (file)
@@ -8,15 +8,6 @@
 
 */
 
 
 */
 
-/**     \addtogroup SURF_simulation
-        \ingroup SURF_API  */
-/**     \addtogroup SURF_actions
-        \ingroup SURF_API  */
-/**     \addtogroup SURF_resources
-        \ingroup SURF_API  */
-/**     \addtogroup SURF_build_api
-        \ingroup SURF_API  */
-
 /** \defgroup SURF_simulation Simulation
     \ingroup SURF_API
     \brief Functions for creating the environment and launching the simulation
 /** \defgroup SURF_simulation Simulation
     \ingroup SURF_API
     \brief Functions for creating the environment and launching the simulation
@@ -64,8 +55,9 @@
     surf_workstation_resource_init_CLM03() or surf_workstation_resource_init_KCCFLN05()
     to create the platform.
 
     surf_workstation_resource_init_CLM03() or surf_workstation_resource_init_KCCFLN05()
     to create the platform.
 
-    Then you can access the workstations and the network links with the global variables \ref workstation_set
-    and \ref network_link_set. Some functions in \a surf_workstation_resource->extension_public can give
+    Then you can access the workstations and the network links with
+    the global variables \ref host_lib
+    and \ref link_lib. Some functions in \a surf_workstation_resource->extension_public can give
     you some information about:
        - a workstation: get_speed(), get_available_speed();
        - a network link: get_link_name(), get_link_latency(), get_link_bandwith();
     you some information about:
        - a workstation: get_speed(), get_available_speed();
        - a network link: get_link_name(), get_link_latency(), get_link_bandwith();
index c2dbd83..465e3a3 100644 (file)
 #include "surf/surf_routing.h"
 #include "surf/surfxml_parse_values.h"
 
 #include "surf/surf_routing.h"
 #include "surf/surfxml_parse_values.h"
 
+/**
+ * @ingroup SURF_build_api
+ * @brief A library containing all known workstations
+ */
 xbt_lib_t host_lib;
 xbt_lib_t host_lib;
+
 int ROUTING_HOST_LEVEL;         //Routing level
 int SURF_CPU_LEVEL;             //Surf cpu level
 int SURF_WKS_LEVEL;             //Surf workstation level
 int ROUTING_HOST_LEVEL;         //Routing level
 int SURF_CPU_LEVEL;             //Surf cpu level
 int SURF_WKS_LEVEL;             //Surf workstation level
@@ -22,6 +27,10 @@ int SD_HOST_LEVEL;              //Simdag level
 int COORD_HOST_LEVEL=0;         //Coordinates level
 int NS3_HOST_LEVEL;             //host node for ns3
 
 int COORD_HOST_LEVEL=0;         //Coordinates level
 int NS3_HOST_LEVEL;             //host node for ns3
 
+/**
+ * @ingroup SURF_build_api
+ * @brief A library containing all known links
+ */
 xbt_lib_t link_lib;
 int SD_LINK_LEVEL;              //Simdag level
 int SURF_LINK_LEVEL;            //Surf level
 xbt_lib_t link_lib;
 int SD_LINK_LEVEL;              //Simdag level
 int SURF_LINK_LEVEL;            //Surf level