Add documentation for workstations and fix a few bugs

[simgrid.git] / include / simdag / simdag.h

diff --git a/include/simdag/simdag.h b/include/simdag/simdag.h
index e34f8ce..6efe56b 100644 (file)
--- 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 <em>physical
+ *  resource with computing capabilities</em> and has a <em>name</em>.
+ *
+ *  @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 ************************************/
 
@@ -53,15 +62,16 @@ const char*       SD_task_get_name(SD_task_t task);
 double            SD_task_get_amount(SD_task_t task);
 double            SD_task_get_remaining_amount(SD_task_t task);
 void              SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst);
-void              SD_task_dependency_remove(SD_task_t src, SD_task_t dst); 
-SD_task_state_t   SD_task_get_state(SD_task_t task);
-/* SD_task_state_t can be either SD_SCHEDULED, SD_RUNNING, SD_DONE, or SD_FAILED */
+void              SD_task_dependency_remove(SD_task_t src, SD_task_t dst);
+void*             SD_task_dependency_get_data(SD_task_t src, SD_task_t dst);
+e_SD_task_state_t SD_task_get_state(SD_task_t task);
+/* e_SD_task_state_t can be either SD_SCHEDULED, SD_RUNNING, SD_DONE, or SD_FAILED */
 
-void              SD_task_watch(SD_task_t task, SD_task_state_t state);
+void              SD_task_watch(SD_task_t task, e_SD_task_state_t state);
 /* SD_simulate will stop as soon as the state of this task is the one given in argument.
    Watch-point is then automatically removed */
 
-void              SD_task_unwatch(SD_task_t task, SD_task_state_t state);
+void              SD_task_unwatch(SD_task_t task, e_SD_task_state_t state);
 void              SD_task_unschedule(SD_task_t task); /* change state and rerun */
 void              SD_task_destroy(SD_task_t task);
 
@@ -69,8 +79,8 @@ 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 */
+SD_task_t*        SD_simulate(double how_long); /* returns a NULL-terminated array of SD_task_t whose state has changed */
+void              SD_exit(void); /* cleans everything */
 
 SG_END_DECL()