From 84733adf13f6e36f5861ddd1953e4df97ef2be78 Mon Sep 17 00:00:00 2001 From: Arnaud Giersch Date: Mon, 23 Apr 2018 11:06:14 +0200 Subject: [PATCH] Fix some doxygen warnings. --- doc/Doxyfile.in | 5 ++++- doc/doxygen/platform.doc | 8 ++++---- include/simgrid/host.h | 1 - src/instr/instr_interface.cpp | 6 +++--- src/simix/ActorImpl.cpp | 2 -- src/simix/libsmx.cpp | 1 - src/xbt/xbt_replay.cpp | 2 +- 7 files changed, 12 insertions(+), 13 deletions(-) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index ad0a864426..c7db06ebba 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1460,7 +1460,10 @@ PREDEFINED = XBT_PUBLIC= \ XBT_IMPORT_NO_EXPORT= \ XBT_PUBLIC_DATA=extern \ XBT_INLINE= \ - XBT_PRIVATE= + XBT_PRIVATE= \ + XBT_ATTRIB_DEPRECATED_v321(m)= \ + XBT_ATTRIB_DEPRECATED_v322(m)= \ + XBT_ATTRIB_DEPRECATED_v323(m)= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index 394c478d1f..1ded558927 100644 --- a/doc/doxygen/platform.doc +++ b/doc/doxygen/platform.doc @@ -616,7 +616,7 @@ that include storage facilities: Entity name | Description --------------- | ----------- \ref pf_storage_entity_storage_type "storage_type" | Defines a template for a particular kind of storage (such as a hard-drive) and specifies important features of the storage, such as capacity, performance (read/write), contents, ... Different models of hard-drives use different storage_types (because the difference between an SSD and an HDD does matter), as they differ in some specifications (e.g., different sizes or read/write performance). -\ref pf_storage_entity_storage "storage" | Defines an actual instance of a storage type (disk, RAM, ...); uses a ``storage_type`` template (see line above) so that you don't need to re-specify the same details over and over again. +\ref pf_tag_storage "storage" | Defines an actual instance of a storage type (disk, RAM, ...); uses a ``storage_type`` template (see line above) so that you don't need to re-specify the same details over and over again. \ref pf_tag_mount "mount" | Must be wrapped by a \ref pf_tag_host tag; declares which storage(s) this host has mounted and where (i.e., the mountpoint). @@ -751,7 +751,7 @@ called alice (which is again not defined here). | Attribute | Mandatory | Values | Description | | ----------- | ----------- | -------- | ------------- | -| id | yes | string | Refers to a \ref pf_storage_entity_storage "<storage>" entity that will be mounted on that computer | +| id | yes | string | Refers to a \ref pf_tag_storage "<storage>" entity that will be mounted on that computer | | name | yes | string | Path/location to/of the logical reference (mount point) of this disk This tag must be enclosed by a \ref pf_tag_host tag. It then specifies where the mountpoint of a given storage device (defined by the ``id`` attribute) @@ -784,7 +784,7 @@ Here is a simple example, taken from the file ``examples/platform/storage.xml``: This example is quite interesting, as the same device, called "Disk2", is mounted by two hosts at the same time! Note, however, that the host called ``alice`` is actually -attached to this storage, as can be seen in the \ref pf_storage_entity_storage "<storage>" +attached to this storage, as can be seen in the \ref pf_tag_storage "<storage>" tag. This means that ``denise`` must access this storage through the network, but SimGrid automatically takes care of that for you. @@ -836,7 +836,7 @@ RAM -- Host B \endverbatim An easy way to model this scenario is to setup and define the RAM via the -\ref pf_storage_entity_storage "storage" and \ref pf_storage_entity_storage_type "storage type" +\ref pf_tag_storage "storage" and \ref pf_storage_entity_storage_type "storage type" entities and attach it to a remote dummy host; then, every host can have their own links to this host (modelling for instance certain scenarios, such as PCIe ...) diff --git a/include/simgrid/host.h b/include/simgrid/host.h index 44b38960ab..30a58f5fd7 100644 --- a/include/simgrid/host.h +++ b/include/simgrid/host.h @@ -95,7 +95,6 @@ XBT_PUBLIC int sg_host_core_count(sg_host_t host); /** \ingroup m_process_management * \brief Return the location on which a process is running. - * \param process a process (nullptr means the current one) * \return the sg_host_t corresponding to the location on which \a process is running. */ XBT_PUBLIC sg_host_t sg_host_self(); diff --git a/src/instr/instr_interface.cpp b/src/instr/instr_interface.cpp index 62ca5c1a8f..6a1cf3eb5f 100644 --- a/src/instr/instr_interface.cpp +++ b/src/instr/instr_interface.cpp @@ -948,8 +948,8 @@ void TRACE_host_set_state(const char* host, const char* state_name, const char* * Change a user state previously declared by pushing the new value to the state. * * \param host The name of the host to be considered. - * \param state The name of the state previously declared. - * \param value The value to be pushed. + * \param state_name The name of the state previously declared. + * \param value_name The value to be pushed. * * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_pop_state, TRACE_host_reset_state */ @@ -964,7 +964,7 @@ void TRACE_host_push_state(const char* host, const char* state_name, const char* * Change a user state previously declared by removing the last value of the state. * * \param host The name of the host to be considered. - * \param state The name of the state to be popped. + * \param state_name The name of the state to be popped. * * \see TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_push_state, TRACE_host_reset_state */ diff --git a/src/simix/ActorImpl.cpp b/src/simix/ActorImpl.cpp index 0f9b3308ca..c6fa17a68b 100644 --- a/src/simix/ActorImpl.cpp +++ b/src/simix/ActorImpl.cpp @@ -795,11 +795,9 @@ void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart) { * be nullptr. * It can be retrieved with the function \ref simcall_process_get_data. * \param host where the new agent is executed. - * \param kill_time time when the process is killed * \param argc first argument passed to \a code * \param argv second argument passed to \a code * \param properties the properties of the process - * \param auto_restart either it is autorestarting or not. */ smx_actor_t simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host, int argc, char** argv, std::map* properties) diff --git a/src/simix/libsmx.cpp b/src/simix/libsmx.cpp index 2ecba30dc4..1be566c673 100644 --- a/src/simix/libsmx.cpp +++ b/src/simix/libsmx.cpp @@ -78,7 +78,6 @@ smx_activity_t simcall_execution_start(const char* name, double flops_amount, do * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes) * \param bytes_amount Array (of size host_nb * host_nb) representing the communication * amount between each pair of hosts - * \param amount the SURF action amount * \param rate the SURF action rate * \param timeout timeout * \return A new SIMIX execution synchronization diff --git a/src/xbt/xbt_replay.cpp b/src/xbt/xbt_replay.cpp index d57b1bea01..b889434cf9 100644 --- a/src/xbt/xbt_replay.cpp +++ b/src/xbt/xbt_replay.cpp @@ -158,7 +158,7 @@ int replay_runner(int argc, char* argv[]) * \brief Registers a function to handle a kind of action * * Registers a function to handle a kind of action - * This table is then used by \ref xbt_replay_action_runner + * This table is then used by \ref simgrid::xbt::replay_runner * * The argument of the function is the line describing the action, fields separated by spaces. * -- 2.20.1