X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/96f99f2c43f129472ec7603caef3e370be91e13e..87f40446646326cb07fe9d8f15034826c2fa9d19:/include/simdag/simdag.h
diff --git a/include/simdag/simdag.h b/include/simdag/simdag.h
index a1f2a96bbd..6efe56bc0f 100644
--- a/include/simdag/simdag.h
+++ b/include/simdag/simdag.h
@@ -23,9 +23,19 @@ void SD_link_destroy(SD_link_t link);
/************************** Workstation handling ****************************/
-/* private (called by SD_environment_create)
-SD_workstation_t SD_workstation_create(void *data, const char *name, double power,
- double available_power);*/
+/** @defgroup SD_workstation_management Workstations
+ * @brief Functions for managing the workstations
+ *
+ * This section describes the functions for managing the workstations.
+ *
+ * A workstation is a place where a task can be executed.
+ * A workstation is represented as a physical
+ * resource with computing capabilities and has a name.
+ *
+ * @see SD_workstation_t
+ *
+ * @{
+ */
SD_workstation_t SD_workstation_get_by_name(const char *name);
SD_workstation_t* SD_workstation_get_list(void);
int SD_workstation_get_number(void);
@@ -36,9 +46,8 @@ SD_link_t* SD_workstation_route_get_list(SD_workstation_t src, SD_workst
int SD_workstation_route_get_size(SD_workstation_t src, SD_workstation_t dst);
double SD_workstation_get_power(SD_workstation_t workstation);
double SD_workstation_get_available_power(SD_workstation_t workstation);
-/* private (called by SD_clean)
-void SD_workstation_destroy(SD_workstation_t workstation);
-*/
+
+/** @} */
/************************** Task handling ************************************/
@@ -71,7 +80,7 @@ void SD_task_destroy(SD_task_t task);
void SD_init(int *argc, char **argv);
void SD_create_environment(const char *platform_file);
SD_task_t* SD_simulate(double how_long); /* returns a NULL-terminated array of SD_task_t whose state has changed */
-void SD_exit(); /* cleans everything */
+void SD_exit(void); /* cleans everything */
SG_END_DECL()