X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ca7838c3440b5dab4545fc2ebdfc52ff0717cf3a..87f40446646326cb07fe9d8f15034826c2fa9d19:/src/simdag/sd_workstation.c

diff --git a/src/simdag/sd_workstation.c b/src/simdag/sd_workstation.c
index 567cd0bd71..05bf3d3bdc 100644
--- a/src/simdag/sd_workstation.c
+++ b/src/simdag/sd_workstation.c
@@ -21,7 +21,13 @@ SD_workstation_t __SD_workstation_create(void *surf_workstation, void *data) {
   return workstation;
 }
 
-/* Returns a workstation given its name, or NULL if there is no such workstation.
+/** @ingroup SD_workstation_management
+ * @brief Returns a workstation given its name
+ *
+ * If there is no such workstation, the function returns NULL.
+ *
+ * @param name workstation name
+ * @return the workstation, or NULL if there is no such workstation
  */
 SD_workstation_t SD_workstation_get_by_name(const char *name) {
   SD_CHECK_INIT_DONE();
@@ -31,12 +37,19 @@ SD_workstation_t SD_workstation_get_by_name(const char *name) {
   return xbt_dict_get_or_null(sd_global->workstations, name);
 }
 
-/* Returns a NULL-terminated array of existing workstations.
+/** @ingroup SD_workstation_management
+ * @brief Returns the workstations list
+ *
+ * Use SD_workstation_get_number to known the array size.
+ *
+ * @return an array of SD_workstation_t containing all workstations
+ * @see SD_workstation_get_number
  */
 SD_workstation_t*  SD_workstation_get_list(void) {
   SD_CHECK_INIT_DONE();
+  xbt_assert0(SD_workstation_get_number() > 0, "There is no workstation!");
 
-  SD_workstation_t* array = xbt_new0(SD_workstation_t, sd_global->workstation_count + 1);
+  SD_workstation_t* array = xbt_new0(SD_workstation_t, sd_global->workstation_count);
   
   xbt_dict_cursor_t cursor;
   char *key;
@@ -46,19 +59,30 @@ SD_workstation_t*  SD_workstation_get_list(void) {
   xbt_dict_foreach(sd_global->workstations, cursor, key, data) {
     array[i++] = (SD_workstation_t) data;
   }
-  array[i] = NULL;
 
   return array;
 }
 
-/* Returns the number or workstations.
+/** @ingroup SD_workstation_management
+ * @brief Returns the number of workstations
+ *
+ * @return the number of existing workstations
+ * @see SD_workstation_get_list
  */
 int SD_workstation_get_number(void) {
   SD_CHECK_INIT_DONE();
   return sd_global->workstation_count;
 }
 
-/* Sets the data of a workstation. The new data can be NULL. The old data should have been freed first if it was not NULL.
+/** @ingroup SD_workstation_management
+ * @brief Sets the user data of a workstation
+ *
+ * The new data can be NULL. The old data should have been freed first
+ * if it was not NULL.
+ *
+ * @param workstation a workstation
+ * @param data the new data you want to associate with this workstation
+ * @see SD_workstation_get_data
  */
 void SD_workstation_set_data(SD_workstation_t workstation, void *data) {
   SD_CHECK_INIT_DONE();
@@ -66,7 +90,12 @@ void SD_workstation_set_data(SD_workstation_t workstation, void *data) {
   workstation->data = data;
 }
 
-/* Returns the data of a workstation. The user data can be NULL.
+/** @ingroup SD_workstation_management
+ * @brief Returns the user data of a workstation
+ *
+ * @param workstation a workstation
+ * @return the user data associated with this workstation (can be NULL)
+ * @see SD_workstation_set_data
  */
 void* SD_workstation_get_data(SD_workstation_t workstation) {
   SD_CHECK_INIT_DONE();
@@ -74,7 +103,11 @@ void* SD_workstation_get_data(SD_workstation_t workstation) {
   return workstation->data;
 }
 
-/* Returns the name of a workstation.
+/** @ingroup SD_workstation_management
+ * @brief Returns the name of a workstation
+ *
+ * @param workstation a workstation
+ * @return the name of this workstation (cannot be NULL)
  */
 const char* SD_workstation_get_name(SD_workstation_t workstation) {
   SD_CHECK_INIT_DONE();
@@ -82,7 +115,15 @@ const char* SD_workstation_get_name(SD_workstation_t workstation) {
   return surf_workstation_resource->common_public->get_resource_name(workstation->surf_workstation);
 }
 
-/* Returns an new array of links representating the route between two workstations.
+/** @ingroup SD_workstation_management
+ * @brief Returns the route between two workstations
+ *
+ * Use SD_workstation_route_get_size to known the array size.
+ *
+ * @param src a workstation
+ * @param dst another workstation
+ * @return a new array of SD_link_t representating the route between these two workstations
+ * @see SD_workstation_route_get_size
  */
 SD_link_t* SD_workstation_route_get_list(SD_workstation_t src, SD_workstation_t dst) {
   SD_CHECK_INIT_DONE();
@@ -104,7 +145,13 @@ SD_link_t* SD_workstation_route_get_list(SD_workstation_t src, SD_workstation_t
   return route;
 }
 
-/* Returns the number of links on the route between two workstations.
+/** @ingroup SD_workstation_management
+ * @brief Returns the number of links on the route between two workstations
+ *
+ * @param src a workstation
+ * @param dst another workstation
+ * @return the number of links on the route between these two workstations
+ * @see SD_workstation_route_get_list
  */
 int SD_workstation_route_get_size(SD_workstation_t src, SD_workstation_t dst) {
   SD_CHECK_INIT_DONE();
@@ -112,7 +159,12 @@ int SD_workstation_route_get_size(SD_workstation_t src, SD_workstation_t dst) {
     get_route_size(src->surf_workstation, dst->surf_workstation);
 }
 
-/* Returns the total power of a workstation.
+/** @ingroup SD_workstation_management
+ * @brief Returns the total power of a workstation
+ *
+ * @param workstation a workstation
+ * @return the total power of this workstation
+ * @see SD_workstation_get_available_power
  */
 double SD_workstation_get_power(SD_workstation_t workstation) {
   SD_CHECK_INIT_DONE();
@@ -120,7 +172,12 @@ double SD_workstation_get_power(SD_workstation_t workstation) {
   return surf_workstation_resource->extension_public->get_speed(workstation->surf_workstation, 1.0);
 }
 
-/* Returns the proportion of available power in a workstation (normally a number between 0 and 1).
+/** @ingroup SD_workstation_management
+ * @brief Returns the proportion of available power in a workstation
+ *
+ * @param workstation a workstation
+ * @return the proportion of power currently available in this workstation (normally a number between 0 and 1)
+ * @see SD_workstation_get_power
  */
 double SD_workstation_get_available_power(SD_workstation_t workstation) {
   SD_CHECK_INIT_DONE();
@@ -128,7 +185,7 @@ double SD_workstation_get_available_power(SD_workstation_t workstation) {
   return surf_workstation_resource->extension_public->get_available_speed(workstation->surf_workstation);
 }
 
-/* Destroys a workstation. The user data (if any) should have been destroyed first.
+/* Destroys a workstation.
  */
 void __SD_workstation_destroy(void *workstation) {
   SD_CHECK_INIT_DONE();