From: alegrand Date: Fri, 1 Jul 2005 05:55:20 +0000 (+0000) Subject: major doc reorganization to get something that works... X-Git-Tag: v3.3~3846 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/047faaf9f860833fec42238f3f0df8ae518a4cc4 major doc reorganization to get something that works... git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@1509 48e7efb5-ca39-0410-a469-dd3cf9ba447f --- diff --git a/doc/module-msg.doc b/doc/module-msg.doc index 97700835f4..09809a8de9 100644 --- a/doc/module-msg.doc +++ b/doc/module-msg.doc @@ -1,4 +1,4 @@ -/** \addtogroup MSG_API +/** @addtogroup MSG_API \section MSG_funct Offered functionnalities - \ref m_process_management @@ -15,8 +15,9 @@ - \ref MSG_ex_master_slave */ -/** \addtogroup m_datatypes_management - \ingroup MSG_API */ +/** @defgroup m_datatypes_management MSG Data Types + @brief This section describes the different datatypes provided by MSG. +*/ /** \addtogroup m_process_management \ingroup MSG_API */ /** \addtogroup m_host_management diff --git a/include/msg/datatypes.h b/include/msg/datatypes.h index 08bd974a58..2a7c810abc 100644 --- a/include/msg/datatypes.h +++ b/include/msg/datatypes.h @@ -11,14 +11,19 @@ BEGIN_DECL() -/** \defgroup m_datatypes_management MSG Data Types - \brief This section describes the different datatypes provided by MSG. -*/ - -/********************************* Host **************************************/ +/* ******************************** Host ************************************ */ +/** @defgroup m_datatypes_management_details */ -/** @name Host datatype - \ingroup m_datatypes_management +typedef struct simdata_host *simdata_host_t; +/** @brief Host datatype + @ingroup m_datatypes_management_details */ +typedef struct m_host { + char *name; /**< @brief host name if any */ + simdata_host_t simdata; /**< @brief simulator data */ + void *data; /**< @brief user data */ +} s_m_host_t; +/** @brief Host datatype + @ingroup m_datatypes_management A location (or host) is any possible place where a process may run. Thus it is represented as a physical @@ -28,109 +33,117 @@ BEGIN_DECL() process. \see m_host_management -*/ -/* @{ */ -typedef struct simdata_host *simdata_host_t; -typedef struct m_host { - char *name; /**< host name if any */ - simdata_host_t simdata; /**< simulator data */ - void *data; /**< user data */ -} s_m_host_t, *m_host_t; -/* @} */ -/********************************* Task **************************************/ - -/** @name Task datatype - \ingroup m_datatypes_management + @{ */ +typedef struct m_host *m_host_t; +/** @} */ +/* ******************************** Task ************************************ */ + +typedef struct simdata_task *simdata_task_t; +/** @brief Task datatype + @ingroup m_datatypes_management_details */ +typedef struct m_task { + char *name; /**< @brief host name if any */ + simdata_task_t simdata; /**< @brief simulator data */ + void *data; /**< @brief user data */ +} s_m_task_t; +/** @brief Task datatype + @ingroup m_datatypes_management A task may then be defined by a computing amount, a message size and some private data. \see m_task_management -*/ -/* @{ */ -typedef struct simdata_task *simdata_task_t; -typedef struct m_task { - char *name; /* host name if any */ - simdata_task_t simdata; /* simulator data */ - void *data; /* user data */ -} s_m_task_t, *m_task_t; + @{ */ +typedef struct m_task *m_task_t; /** \brief Default value for an uninitialized #m_task_t. \ingroup m_datatypes_management */ #define MSG_TASK_UNINITIALIZED NULL -/* @} */ +/** @} */ -/******************************* Process *************************************/ - -/** @name Agent datatype - \ingroup m_datatypes_management +/* ****************************** Process *********************************** */ +typedef struct simdata_process *simdata_process_t; +/** @brief Process datatype + @ingroup m_datatypes_management_details @{ */ +typedef struct m_process { + char *name; /**< @brief process name if any */ + simdata_process_t simdata; /**< @brief simulator data */ + void *data; /**< @brief user data */ +} s_m_process_t; +/** @} */ +/** @brief Agent datatype + @ingroup m_datatypes_management An agent may be defined as a code, with some private data, executing in a location. \see m_process_management -*/ -/* @{ */ -typedef struct simdata_process *simdata_process_t; -typedef struct m_process { - /** A name */ - /** process name if any */ - char *name; - simdata_process_t simdata; /* simulator data */ - void *data; /* user data */ -} s_m_process_t, *m_process_t; - -/** + @{ */ +typedef struct m_process *m_process_t; +/** @} */ + +/** @brief Agent code + @ingroup m_datatypes_management The code of an agent is a m_process_code_t, i.e. a function with no arguments returning no value. \see m_process_management -*/ + @{ */ typedef int(*m_process_code_t)(int argc,char *argv[]) ; -/* @} */ +/** @} */ -/********************************** Channel **********************************/ -/** @name Channel datatype - \ingroup m_datatypes_management +/* ********************************* Channel ******************************** */ +/** @brief Channel datatype + @ingroup m_datatypes_management A channel is a number and identifies a mailbox type (just as a port number does). \see m_channel_management -*/ -/* @{ */ + @{ */ typedef int m_channel_t; -/* @} */ +/** @} */ -/****************************** Error handling *******************************/ -/** \brief Error handling -*/typedef enum { - MSG_OK = 0, /**< Everything is right. Keep on going this way ! */ - MSG_WARNING, /**< Mmmh! Something must be not perfectly clean. But I +/* ***************************** Error handling ***************************** */ +/** @brief Error handling + @ingroup m_datatypes_management + @{ +*/ +typedef enum { + MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */ + MSG_WARNING, /**< @brief Mmmh! Something must be not perfectly clean. But I may be a paranoid freak... ! */ - MSG_TRANSFER_FAILURE, /**< There has been a problem during you task + MSG_TRANSFER_FAILURE, /**< @brief There has been a problem during you task transfer. Either the network is down or the remote host has been shutdown. */ - MSG_HOST_FAILURE, /**< System shutdown. The host on which you are + MSG_HOST_FAILURE, /**< @brief System shutdown. The host on which you are running has just been rebooted. Free your datastructures and return now !*/ - MSG_FATAL /**< You've done something wrong. You'd better look at it... */ + MSG_FATAL /**< @brief You've done something wrong. You'd better look at it... */ } MSG_error_t; +/** @} */ + +/** @deprecated MSG verbosity + @ingroup m_datatypes_management +*/ typedef enum { MSG_SILENT = 0, MSG_SOME, MSG_VERBOSE } MSG_outputmode_t; -/** \deprecated Network sharing mechanism - \ingroup m_datatypes_management*/ + +/** @deprecated Network sharing mechanism + @ingroup m_datatypes_management + @brief Sharing policy : 0 means uninitialized value +*/ typedef enum { - MSG_STORE_AND_FORWARD = 1, /* 0 means uninitialized value */ - MSG_TCP + MSG_STORE_AND_FORWARD = 1, /**< Packet level simulation of communications. Bad */ + MSG_TCP /**< Continuous model of network communications. Good */ } MSG_sharing_t; -/** \deprecated Link datatype - * \ingroup m_datatypes_management +/** @deprecated Link datatype + * @ingroup m_datatypes_management * The notion of link was present in the earliest versions of MSG. * It was an agglomeration of communicating resources representing a set of * physical network links. This abstraction a disappeared because in real-life,