From 9d7c5c0eb4e73fa63ad242da6bcfd2be6d9f2752 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Tue, 3 Apr 2012 17:35:42 -1000 Subject: [PATCH] rename doxygen group m_file_management into msg_file_management --- doc/module-msg.doc | 6 +++--- doc/platform.doc | 5 ++++- src/msg/msg_io.c | 14 +++++++------- 3 files changed, 14 insertions(+), 11 deletions(-) diff --git a/doc/module-msg.doc b/doc/module-msg.doc index 5c7a3e256d..9aaeb9e6dc 100644 --- a/doc/module-msg.doc +++ b/doc/module-msg.doc @@ -17,7 +17,7 @@ - \ref m_datatypes_management - \ref m_host_management - \ref m_task_management - - \ref m_file_management + - \ref msg_file_management - \ref msg_trace_driven - \ref msg_gos_functions - \ref msg_deprecated_functions @@ -86,10 +86,10 @@ details). * (#m_task_t) and the functions for managing it. */ - /** @defgroup m_file_management File Management Functions + /** @defgroup msg_file_management File Management Functions * @ingroup MSG_API * @brief This section describes the file structure of MSG - * (#m_file_t) and the functions for managing it. It + * (#msg_file_t) and the functions for managing it. It * is based on POSIX functions. */ diff --git a/doc/platform.doc b/doc/platform.doc index 3f83990f1c..44b69df4ea 100644 --- a/doc/platform.doc +++ b/doc/platform.doc @@ -406,7 +406,10 @@ As an host, a link tag can also contain the prop tag. \subsection pf_storage Storage Note : This is a prototype version that should evolve quickly, this is just some doc valuable only at the time of writing this doc -This section describes the storage management under SimGrid ; nowadays it's only usable with MSG. It relies basically on linux-like concepts. You also may want to have a look to its corresponding section in \ref m_file_management ; functions access are organized as a POSIX-like interface. +This section describes the storage management under SimGrid ; nowadays +it's only usable with MSG. It relies basically on linux-like concepts. +You also may want to have a look to its corresponding section in \ref +msg_file_management ; functions access are organized as a POSIX-like interface. \subsubsection pf_sto_conc Storage Main concepts Basically there is 3 different entities to know : diff --git a/src/msg/msg_io.c b/src/msg/msg_io.c index c8b64de2d5..dc892257bb 100644 --- a/src/msg/msg_io.c +++ b/src/msg/msg_io.c @@ -10,8 +10,8 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, simix, "Logging specific to MSG (io)"); -/** @addtogroup m_file_management - * \htmlonly \endhtmlonly +/** @addtogroup msg_file_management + * \htmlonly \endhtmlonly * (#msg_file_t) and the functions for managing it. * * \see #msg_file_t @@ -19,7 +19,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_io, simix, /********************************* File **************************************/ -/** \ingroup m_file_management +/** \ingroup msg_file_management * \brief Read elements of a file * * \param storage is the name where find the stream @@ -34,7 +34,7 @@ size_t MSG_file_read(const char* storage, void* ptr, size_t size, size_t nmemb, return simcall_file_read(storage, ptr, size, nmemb, stream->simdata->smx_file); } -/** \ingroup m_file_management +/** \ingroup msg_file_management * \brief Write elements into a file * * \param storage is the name where find the stream @@ -49,7 +49,7 @@ size_t MSG_file_write(const char* storage, const void* ptr, size_t size, size_t return simcall_file_write(storage, ptr, size, nmemb, stream->simdata->smx_file); } -/** \ingroup m_file_management +/** \ingroup msg_file_management * \brief Opens the file whose name is the string pointed to by path * * \param storage is the name where find the file to open @@ -75,7 +75,7 @@ msg_file_t MSG_file_open(const char* storage, const char* path, const char* mode return file; } -/** \ingroup m_file_management +/** \ingroup msg_file_management * \brief Close the file * * \param storage is the name where find the stream @@ -87,7 +87,7 @@ int MSG_file_close(const char* storage, msg_file_t fp) return simcall_file_close(storage, fp->simdata->smx_file); } -/** \ingroup m_file_management +/** \ingroup msg_file_management * \brief Stats the file pointed by fd * * \param storage is the name where find the stream -- 2.20.1