X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/eee4fd8a61935c3b7cbefe0768e040eeea1c9336..1e5e4a470ede08f4055218978210e6c6e7fb751a:/include/simgrid/simdag.h

diff --git a/include/simgrid/simdag.h b/include/simgrid/simdag.h
index 0978733cda..77f9ea6eee 100644
--- a/include/simgrid/simdag.h
+++ b/include/simgrid/simdag.h
@@ -10,37 +10,33 @@
 #include "xbt/misc.h"
 #include "xbt/dynar.h"
 #include "xbt/dict.h"
-
+#include "xbt/asserts.h"
+#include "xbt/log.h"
 #include "simgrid/link.h"
+#include "simgrid/host.h"
 
 SG_BEGIN_DECL()
 
-/** @brief Link datatype
-    @ingroup SD_datatypes_management
-
-    A link is a network node represented as a <em>name</em>, a <em>current
-    bandwidth</em> and a <em>current latency</em>. A route is a list of
-    links between two workstations.
+/** @brief Link opaque datatype
+    @ingroup SD_link_api
 
-    @see SD_link_management */
+    A link is a network node represented as a <em>name</em>, a <em>bandwidth</em> and a <em>latency</em>.
+    A route is a list of links between two hosts.
+ */
 typedef Link *SD_link_t;
 
-/** @brief Task datatype
-    @ingroup SD_datatypes_management
+/** @brief Task opaque datatype
+    @ingroup SD_task_api
 
-    A task is some <em>computing amount</em> that can be executed
-    in parallel on several workstations. A task may depend on other
-    tasks, this means that the task cannot start until the other tasks are done.
-    Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether
-    the task is scheduled, running, done, etc.
+    A task is some <em>computing amount</em> that can be executed in parallel on several hosts.
+    A task may depend on other tasks, which means that the task cannot start until the other tasks are done.
+    Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, ...
 
-    @see SD_task_management */
+    */
 typedef struct SD_task *SD_task_t;
 
 /** @brief Task states
-    @ingroup SD_datatypes_management
-
-    @see SD_task_management */
+    @ingroup SD_task_api */
 typedef enum {
   SD_NOT_SCHEDULED = 0,      /**< @brief Initial state (not valid for SD_watch and SD_unwatch). */
   SD_SCHEDULABLE = 0x0001,   /**< @brief A task becomes SD_SCHEDULABLE as soon as its dependencies are satisfied */
@@ -53,9 +49,7 @@ typedef enum {
 } e_SD_task_state_t;
 
 /** @brief Task kinds
-    @ingroup SD_datatypes_management
-
-    @see SD_task_management */
+    @ingroup SD_task_api */
 typedef enum {
   SD_TASK_NOT_TYPED = 0,      /**< @brief no specified type */
   SD_TASK_COMM_E2E = 1,       /**< @brief end to end communication */
@@ -64,33 +58,22 @@ typedef enum {
   SD_TASK_COMM_PAR_MXN_1D_BLOCK = 4 /**< @brief MxN data redistribution (1D Block distribution) */
 } e_SD_task_kind_t;
 
-
 /** @brief Storage datatype
-    @ingroup SD_datatypes_management
-
- TODO PV: comment it !
-
-    @see SD_storage_management */
+    @ingroup SD_storage_api */
 typedef xbt_dictelm_t SD_storage_t;
 
 /************************** Workstation handling ****************************/
-
-/** @defgroup sg_host_management Hosts
- *  @brief Functions for managing the Hosts
- *
- *  This section describes the functions for managing the hosts.
+/** @addtogroup SD_host_api
  *
  *  A host is a place where a task can be executed.
- *  A host is represented as a <em>physical resource with computing
- *  capabilities</em> and has a <em>name</em>.
+ *  A host is represented as a <em>physical resource with computing capabilities</em> and has a <em>name</em>.
  *
- *  The hosts are created when you call the function SD_create_environment.
+ *  The hosts are created from the description file when you call the function SD_create_environment.
  *
  *  @see sg_host_t
  *  @{
  */
-XBT_PUBLIC(const SD_link_t *) SD_route_get_list(sg_host_t src,
-                                                sg_host_t dst);
+XBT_PUBLIC(SD_link_t *) SD_route_get_list(sg_host_t src, sg_host_t dst);
 XBT_PUBLIC(int) SD_route_get_size(sg_host_t src, sg_host_t dst);
 
 XBT_PUBLIC(double) SD_route_get_latency(sg_host_t src, sg_host_t dst);
@@ -100,17 +83,16 @@ XBT_PUBLIC(const char*) SD_storage_get_host(SD_storage_t storage);
 /** @} */
 
 /************************** Task handling ************************************/
-
-/** @defgroup SD_task_management Tasks
+/** @defgroup SD_task_api Tasks
  *  @brief Functions for managing the tasks
  *
  *  This section describes the functions for managing the tasks.
  *
- *  A task is some <em>working amount</em> that can be executed in parallel on several hosts. A task may depend on other
- *  tasks, this means that the task cannot start until the other tasks are done. Each task has a
- *  <em>\ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, etc.
+ *  A task is some <em>working amount</em> that can be executed in parallel on several hosts.
+ *  A task may depend on other tasks, which means that the task cannot start until the other tasks are done.
+ *  Each task has a <em>\ref e_SD_task_state_t "state"</em> indicating whether the task is scheduled, running, done, ...
  *
- *  @see SD_task_t, SD_task_dependency_management
+ *  @see SD_task_t, @see SD_task_dependency_api
  *  @{
  */
 XBT_PUBLIC(SD_task_t) SD_task_create(const char *name, void *data, double amount);
@@ -163,13 +145,11 @@ XBT_PUBLIC(void) SD_task_schedulel(SD_task_t task, int count, ...);
 
 /** @} */
 
-
-/** @defgroup SD_task_dependency_management Tasks dependencies
- *  @brief Functions for managing the task dependencies
- *
+/** @addtogroup SD_task_dependency_api 
+ * 
  *  This section describes the functions for managing the dependencies between the tasks.
  *
- *  @see SD_task_management
+ *  @see SD_task_api
  *  @{
  */
 XBT_PUBLIC(void) SD_task_dependency_add(const char *name, void *data, SD_task_t src, SD_task_t dst);
@@ -180,9 +160,7 @@ XBT_PUBLIC(int) SD_task_dependency_exists(SD_task_t src, SD_task_t dst);
 /** @} */
 
 /************************** Global *******************************************/
-
-/** @defgroup SD_simulation Simulation
- *  @brief Functions for creating the environment and launching the simulation
+/** @addtogroup SD_simulation Simulation
  *
  *  This section describes the functions for initializing SimDag, launching the simulation and exiting SimDag.
  *
@@ -196,8 +174,8 @@ XBT_PUBLIC(double) SD_get_clock(void);
 XBT_PUBLIC(void) SD_exit(void);
 XBT_PUBLIC(xbt_dynar_t) SD_daxload(const char *filename);
 XBT_PUBLIC(xbt_dynar_t) SD_dotload(const char *filename);
-XBT_PUBLIC(xbt_dynar_t) SD_PTG_dotload(const char *filename);
 XBT_PUBLIC(xbt_dynar_t) SD_dotload_with_sched(const char *filename);
+XBT_PUBLIC(xbt_dynar_t) SD_PTG_dotload(const char *filename);
 
 /** @} */
 
@@ -234,7 +212,4 @@ XBT_PUBLIC(xbt_dynar_t) SD_dotload_with_sched(const char *filename);
 //TRACE_sd_set_task_category
 
 SG_END_DECL()
-
-#include "simgrid/instr.h"
-
 #endif