From d7de2f8eb00821d8def1edf69bd77a4a54256fa8 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Mon, 26 Dec 2011 01:43:55 +0100 Subject: [PATCH 1/1] fix some glitches in documentation generation --- doc/module-msg.doc | 10 +++++----- src/msg/msg_gos.c | 26 ++++++++++---------------- 2 files changed, 15 insertions(+), 21 deletions(-) diff --git a/doc/module-msg.doc b/doc/module-msg.doc index 918d07a23e..cdad6beaf3 100644 --- a/doc/module-msg.doc +++ b/doc/module-msg.doc @@ -14,8 +14,8 @@ You should use MSG if you want to study some heuristics for a given problem you don't really want to implement. If you want to use the C programming language, your are in the right - section. To use the Java programming interface, please refer to - \ref MSG_JAVA. + section. To use the Java or Ruby programming interfaces, please refer to + the documentation provided in the relevant packages. */ @@ -64,9 +64,9 @@ /** @addtogroup MSG_LUA \section MSG_Lua_funct Lua offered functionnalities in MSG - - \ref host_management - - \ref tasks_management - - \ref environment_management + - \ref lua_host_management + - \ref lua_tasks_management + - \ref lua_environment_management \section Lua_examples Examples of lua MSG - \ref MSG_ex_master_slave_lua diff --git a/src/msg/msg_gos.c b/src/msg/msg_gos.c index 7f1e3a56ee..0b8ef870fa 100644 --- a/src/msg/msg_gos.c +++ b/src/msg/msg_gos.c @@ -1,5 +1,4 @@ -/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2004-2011. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ @@ -261,8 +260,7 @@ MSG_error_t MSG_process_sleep(double nb_sec) listening. This value has to be >=0 and < than the maximal number of channels fixed with MSG_set_channel_number(). * \param host the host that is to be watched. - * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING - if \a *task is not equal to \c NULL, and #MSG_OK otherwise. + * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise. */ MSG_error_t MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host) @@ -281,8 +279,7 @@ MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host) * \param channel the channel on which the agent should be listening. This value has to be >=0 and < than the maximal number of channels fixed with MSG_set_channel_number(). - * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING - * if \a *task is not equal to \c NULL, and #MSG_OK otherwise. + * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise. */ MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel) { @@ -304,8 +301,7 @@ MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel) up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task will not be modified and will still be equal to \c NULL when returning. - * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING - if \a *task is not equal to \c NULL, and #MSG_OK otherwise. + * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise. */ MSG_error_t MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel, @@ -786,11 +782,10 @@ m_task_t MSG_comm_get_task(msg_comm_t comm) * \param channel the channel on which the agent should put this task. This value has to be >=0 and < than the maximal number of channels fixed with MSG_set_channel_number(). - * \return #MSG_FATAL if \a task is not properly initialized and - * #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which - * this function was called was shut down. Returns + * \return #MSG_HOST_FAILURE if the host on which + * this function was called was shut down, * #MSG_TRANSFER_FAILURE if the transfer could not be properly done - * (network failure, dest failure) + * (network failure, dest failure) or #MSG_OK if it succeeded. */ MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel) { @@ -834,11 +829,10 @@ MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel, * \param timeout the maximum time to wait for a task before giving up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task will not be modified - * \return #MSG_FATAL if \a task is not properly initialized and -#MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which -this function was called was shut down. Returns + * \return #MSG_HOST_FAILURE if the host on which +this function was called was shut down, #MSG_TRANSFER_FAILURE if the transfer could not be properly done -(network failure, dest failure, timeout...) +(network failure, dest failure, timeout...) or #MSG_OK if the communication succeeded. */ MSG_error_t MSG_task_put_with_timeout(m_task_t task, m_host_t dest, -- 2.20.1