From 7ffa115b390e378b3c55a9068ce183c5d1308ef8 Mon Sep 17 00:00:00 2001 From: thiery Date: Tue, 27 Jun 2006 08:23:28 +0000 Subject: [PATCH] Working on SimDag documentation git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@2445 48e7efb5-ca39-0410-a469-dd3cf9ba447f --- doc/module-sd.doc | 30 ++++++++++++++++++++++++++++++ doc/modules.doc | 4 ++-- include/simdag/datatypes.h | 36 +++++++++++++++++++++++++----------- 3 files changed, 57 insertions(+), 13 deletions(-) create mode 100644 doc/module-sd.doc diff --git a/doc/module-sd.doc b/doc/module-sd.doc new file mode 100644 index 0000000000..95179f622d --- /dev/null +++ b/doc/module-sd.doc @@ -0,0 +1,30 @@ +/** @addtogroup SD_API + + \section SD_func Offered functionnalities + - \ref SD_datatypes_management + - \ref SD_workstation_management + - \ref SD_link_management + - \ref SD_task_management + - \ref SD_dependency_management + - \ref SD_platform_management + - \ref SD_simulation + +*/ + +/** @defgroup SD_datatypes_management SD Data Types + @ingroup SD_API + @brief This section describes the different datatypes provided by SD. + \htmlonly \endhtmlonly +*/ +/** \addtogroup SD_workstation_management + \ingroup SD_API */ +/** \addtogroup SD_link_management + \ingroup SD_API */ +/** \addtogroup SD_task_management + \ingroup SD_API */ +/** \addtogroup SD_dependency_functions + \ingroup SD_API */ +/** \addtogroup SD_platform_management + \ingroup SD_API */ +/** \addtogroup SD_simulation + \ingroup SD_API */ diff --git a/doc/modules.doc b/doc/modules.doc index 4bb608446e..d04280ef35 100644 --- a/doc/modules.doc +++ b/doc/modules.doc @@ -112,10 +112,10 @@ */ -/** \defgroup SD_API SMPI +/** \defgroup SD_API SimDag \ingroup SimGrid_API \brief Programming environment for DAG applications - + PLACEHOLDER \section SD_who Who should use this (and who shouldn't) diff --git a/include/simdag/datatypes.h b/include/simdag/datatypes.h index 8490f8b5f0..2904bd158f 100644 --- a/include/simdag/datatypes.h +++ b/include/simdag/datatypes.h @@ -1,22 +1,36 @@ #ifndef SIMDAG_DATATYPES_H #define SIMDAG_DATATYPES_H -/* Link */ -typedef struct SD_link *SD_link_t; - -/* Workstation */ +/** @brief Workstation datatype + @ingroup SD_datatypes_management + @{ */ typedef struct SD_workstation *SD_workstation_t; +/** @} */ + +/** @brief Link datatype + @ingroup SD_datatypes_management + @{ */ +typedef struct SD_link *SD_link_t; +/** @} */ -/* Task */ +/** @brief Task datatype + @ingroup SD_datatypes_management + @{ */ typedef struct SD_task *SD_task_t; +/** @} */ -/* Task state */ +/** @brief Task states + @ingroup SD_datatypes_management + @{ */ typedef enum { - SD_NOT_SCHEDULED = 0, /* 0 because SD_NOT_SCHEDULED is not a valid state for SD_watch and SD_unwatch */ - SD_SCHEDULED = 0x0001, - SD_RUNNING = 0x0002, - SD_DONE = 0x0004, - SD_FAILED = 0x0008 + SD_NOT_SCHEDULED = 0, /**< @brief Initial state (not valid for SD_watch and SD_unwatch). */ + SD_SCHEDULED = 0x0001, /**< @brief A task becomes SD_SCHEDULED when you call function + SD_task_schedule. SD_simulate will execute it when it becomes SD_READY. */ + SD_READY = 0x0002, /**< @brief A scheduled task becomes ready as soon as its dependencies are satisfied. */ + SD_RUNNING = 0x0004, /**< @brief A ready task becomes running in SD_simulate. */ + SD_DONE = 0x0008, /**< @brief The task is successfuly finished. */ + SD_FAILED = 0x0010 /**< @brief A problem occured. */ } e_SD_task_state_t; +/** @} */ #endif -- 2.20.1