From: Arnaud Giersch Date: Wed, 25 Apr 2018 19:53:19 +0000 (+0200) Subject: Fix more Doxygen warnings. X-Git-Tag: v3.20~322 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/effadf994078b5f7bbc589d3ac0ba2aae8aaa59f Fix more Doxygen warnings. --- diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index c7db06ebba..4f86868c25 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1471,7 +1471,8 @@ PREDEFINED = XBT_PUBLIC= \ # Use the PREDEFINED tag if you want to use a different macro definition that # overrules the definition found in the source code. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = COLL_APPLY COLL_GATHERS COLL_ALLGATHERS COLL_ALLGATHERVS COLL_ALLREDUCES COLL_ALLTOALLS \ + COLL_ALLTOALLVS COLL_BCASTS COLL_REDUCES COLL_REDUCE_SCATTERS COLL_SCATTERS COLL_BARRIERS # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all references to function-like macros diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index 1ded558927..85ee6d9f8e 100644 --- a/doc/doxygen/platform.doc +++ b/doc/doxygen/platform.doc @@ -340,7 +340,7 @@ The hosts generated in the above example are named host-1.cluster, host-2.cluste etc. -\subsubsection pf_peer \ (Vivaldi netzones only) +\subsubsection pf_peer <peer> (Vivaldi netzones only) This tag represents a peer, as in Peer-to-Peer (P2P) networks. This can only be used in Vivaldi NetZones. It creates the following diff --git a/doc/tuto-msg/tuto-msg.doc b/doc/tuto-msg/tuto-msg.doc index d7a1579a26..01b1fb4b64 100644 --- a/doc/tuto-msg/tuto-msg.doc +++ b/doc/tuto-msg/tuto-msg.doc @@ -156,7 +156,7 @@ For a more "fancy" output, you can use simgrid-colorizer. If you installed SimGrid to a non-standard path, you may have to specify the full path to simgrid-colorizer on the above line, such as \c /opt/simgrid/bin/simgrid-colorizer. If you did not install it at all, -you can find it in /bin/colorize. +you can find it in \/bin/colorize. For a classical Gantt-Chart visualization, you can produce a [Paje][fn:5] trace: diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc index 1780dde6c5..9350de181a 100644 --- a/examples/s4u/README.doc +++ b/examples/s4u/README.doc @@ -58,12 +58,8 @@ TODO: document here the examples about plugins - Kill actors. @ref examples/s4u/actor-kill/s4u-actor-kill.cpp \n Actors can forcefully stop other actors with the @ref - simgrid::s4u::Actor::kill(void) method. - - - Kill actors (other function). - @ref examples/s4u/actor-kill-pid/s4u-actor-kill-pid.cpp \n - Actors can forcefully stop other actors with the @ref - simgrid::s4u::Actor::kill(aid_t) method. + simgrid::s4u::Actor::kill(void) or the @ref + simgrid::s4u::Actor::kill(aid_t) methods. - Controling the actor life cycle from the XML. @ref examples/s4u/actor-lifetime/s4u-actor-lifetime.cpp diff --git a/include/simgrid/kernel/future.hpp b/include/simgrid/kernel/future.hpp index f0c8cacb4e..e779c0ad63 100644 --- a/include/simgrid/kernel/future.hpp +++ b/include/simgrid/kernel/future.hpp @@ -137,7 +137,7 @@ private: * You are not expected to use them directly but to create them * implicitely through a @ref simgrid::kernel::Promise. * Alternatively kernel operations could inherit or contain FutureState - * if they are managed with @ref std::shared_ptr. + * if they are managed with std::shared_ptr. **/ template class FutureState : public FutureStateBase { @@ -261,7 +261,7 @@ template Future unwrapFuture(Future> future); * ); * * - * This is based on C++1z @ref std::future but with some differences: + * This is based on C++1z std::future but with some differences: * * * there is no thread synchronization (atomic, mutex, condition variable, * etc.) because everything happens in the SimGrid event loop; @@ -390,7 +390,7 @@ public: /** Get the value from the future * * The future must be valid and ready in order to make this call. - * @ref std::future blocks when the future is not ready but we are + * std::future blocks when the future is not ready but we are * completely single-threaded so blocking would be a deadlock. * After the call, the future becomes invalid. * @@ -424,7 +424,7 @@ Future unwrapFuture(Future> future) * A @ref Promise is connected to some `Future` and can be used to * set its result. * - * Similar to @ref std::promise + * Similar to std::promise * * * // Create a promise and a future: diff --git a/include/simgrid/smpi/replay.hpp b/include/simgrid/smpi/replay.hpp index 0a4f4a6551..3269015c7e 100644 --- a/include/simgrid/smpi/replay.hpp +++ b/include/simgrid/smpi/replay.hpp @@ -151,7 +151,7 @@ public: /** * Base class for all ReplayActions. * Note that this class actually implements the behavior of each action - * while the parsing of the replay arguments is done in the @ActionArgParser class. + * while the parsing of the replay arguments is done in the ActionArgParser class. * In other words: The logic goes here, the setup is done by the ActionArgParser. */ template class ReplayAction { diff --git a/src/instr/instr_interface.cpp b/src/instr/instr_interface.cpp index 6a1cf3eb5f..df6c1c9f53 100644 --- a/src/instr/instr_interface.cpp +++ b/src/instr/instr_interface.cpp @@ -930,8 +930,8 @@ void TRACE_host_state_declare_value (const char *state, const char *value, const * Change a user state previously declared to the given value. * * \param host The name of the host to be considered. - * \param state The name of the state previously declared. - * \param value The new value of the state. + * \param state_name The name of the state previously declared. + * \param value_name The new value of the state. * * \see TRACE_host_state_declare, TRACE_host_push_state, TRACE_host_pop_state, TRACE_host_reset_state */ diff --git a/src/instr/instr_paje_types.cpp b/src/instr/instr_paje_types.cpp index 75049077f6..3f6c5f467d 100644 --- a/src/instr/instr_paje_types.cpp +++ b/src/instr/instr_paje_types.cpp @@ -114,17 +114,17 @@ void VariableType::subEvent(double timestamp, double value) LinkType::LinkType(std::string name, std::string alias, Type* father) : ValueType(name, alias, father) { } -void LinkType::startEvent(container_t startContainer, std::string value, std::string key) +void LinkType::startEvent(Container* startContainer, std::string value, std::string key) { startEvent(startContainer, value, key, -1); } -void LinkType::startEvent(container_t startContainer, std::string value, std::string key, int size) +void LinkType::startEvent(Container* startContainer, std::string value, std::string key, int size) { new LinkEvent(issuer_, this, PAJE_StartLink, startContainer, value, key, size); } -void LinkType::endEvent(container_t endContainer, std::string value, std::string key) +void LinkType::endEvent(Container* endContainer, std::string value, std::string key) { new LinkEvent(issuer_, this, PAJE_EndLink, endContainer, value, key, -1); } diff --git a/src/kernel/activity/ConditionVariableImpl.cpp b/src/kernel/activity/ConditionVariableImpl.cpp index e284d60f6a..a238297a3c 100644 --- a/src/kernel/activity/ConditionVariableImpl.cpp +++ b/src/kernel/activity/ConditionVariableImpl.cpp @@ -33,7 +33,6 @@ smx_cond_t SIMIX_cond_init() /** * \brief Handle a condition waiting simcall without timeouts - * \param simcall the simcall */ void simcall_HANDLER_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex) { @@ -46,7 +45,6 @@ void simcall_HANDLER_cond_wait(smx_simcall_t simcall, smx_cond_t cond, smx_mutex /** * \brief Handle a condition waiting simcall with timeouts - * \param simcall the simcall */ void simcall_HANDLER_cond_wait_timeout(smx_simcall_t simcall, smx_cond_t cond, smx_mutex_t mutex, double timeout) { @@ -91,7 +89,6 @@ ConditionVariableImpl::~ConditionVariableImpl() = default; * * Signalizes a condition and wakes up a sleeping process. * If there are no process sleeping, no action is done. - * \param cond A condition */ void ConditionVariableImpl::signal() { diff --git a/src/kernel/context/Context.cpp b/src/kernel/context/Context.cpp index c1dc592f84..79024d9f89 100644 --- a/src/kernel/context/Context.cpp +++ b/src/kernel/context/Context.cpp @@ -12,6 +12,7 @@ * @brief creates a new context for a user level process * @param code a main function * @param cleanup_func the function to call when the context stops + * @param simix_process */ smx_context_t SIMIX_context_new( std::function code, diff --git a/src/kernel/lmm/lagrange.cpp b/src/kernel/lmm/lagrange.cpp index 17fe3d08b1..e7f71edf3b 100644 --- a/src/kernel/lmm/lagrange.cpp +++ b/src/kernel/lmm/lagrange.cpp @@ -403,6 +403,8 @@ double Lagrange::partial_diff_lambda(double lambda, const Constraint& cnst) /** \brief Attribute the value bound to var->bound. * + * \param func_f function (f) + * \param func_fp partial differential of f (f prime, (f')) * \param func_fpi inverse of the partial differential of f (f prime inverse, (f')^{-1}) * * Set default functions to the ones passed as parameters. diff --git a/src/simdag/sd_task.cpp b/src/simdag/sd_task.cpp index 2cf77b68d3..7fd697eafd 100644 --- a/src/simdag/sd_task.cpp +++ b/src/simdag/sd_task.cpp @@ -667,7 +667,6 @@ void SD_task_unwatch(SD_task_t task, e_SD_task_state_t state) * The estimation is very approximative because the value returned is the time the task would take if it was executed * now and if it was the only task. * - * \param task the task to evaluate * \param host_count number of hosts on which the task would be executed * \param host_list the hosts on which the task would be executed * \param flops_amount computation amount for each host(i.e., an array of host_count doubles) diff --git a/src/simix/ActorImpl.cpp b/src/simix/ActorImpl.cpp index a8585230b6..26ad38bb75 100644 --- a/src/simix/ActorImpl.cpp +++ b/src/simix/ActorImpl.cpp @@ -793,7 +793,7 @@ void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart) { * \param code the main function of the process * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and can * be nullptr. - * It can be retrieved with the function \ref simcall_process_get_data. + * It can be retrieved with the method ActorImpl::getUserData(). * \param host where the new agent is executed. * \param argc first argument passed to \a code * \param argv second argument passed to \a code diff --git a/src/simix/libsmx.cpp b/src/simix/libsmx.cpp index 1be566c673..ae935f923d 100644 --- a/src/simix/libsmx.cpp +++ b/src/simix/libsmx.cpp @@ -55,6 +55,7 @@ void simcall_call(smx_actor_t actor) * \param flops_amount amount Computation amount (in flops) * \param priority computation priority * \param bound + * \param host host where the synchro will be executed * \return A new SIMIX execution synchronization */ smx_activity_t simcall_execution_start(const char* name, double flops_amount, double priority, double bound, diff --git a/src/simix/smx_synchro.cpp b/src/simix/smx_synchro.cpp index f961a2cc78..c2e25e5533 100644 --- a/src/simix/smx_synchro.cpp +++ b/src/simix/smx_synchro.cpp @@ -170,7 +170,6 @@ static void _SIMIX_sem_wait(smx_sem_t sem, double timeout, smx_actor_t issuer, /** * \brief Handles a sem acquire simcall without timeout. - * \param simcall the simcall */ void simcall_HANDLER_sem_acquire(smx_simcall_t simcall, smx_sem_t sem) { @@ -181,7 +180,6 @@ void simcall_HANDLER_sem_acquire(smx_simcall_t simcall, smx_sem_t sem) /** * \brief Handles a sem acquire simcall with timeout. - * \param simcall the simcall */ void simcall_HANDLER_sem_acquire_timeout(smx_simcall_t simcall, smx_sem_t sem, double timeout) { diff --git a/src/smpi/mpi/smpi_group.cpp b/src/smpi/mpi/smpi_group.cpp index 4a50f6c776..ff759eb6b6 100644 --- a/src/smpi/mpi/smpi_group.cpp +++ b/src/smpi/mpi/smpi_group.cpp @@ -30,7 +30,7 @@ Group::Group(int n) : size_(n), rank_to_actor_map_(size_, nullptr), rank_to_inde refcount_ = 1; } -Group::Group(MPI_Group origin) +Group::Group(Group* origin) { if (origin != MPI_GROUP_NULL && origin != MPI_GROUP_EMPTY) { size_ = origin->size(); diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp index fc01cae905..7842043c06 100644 --- a/src/surf/network_interface.hpp +++ b/src/surf/network_interface.hpp @@ -182,7 +182,7 @@ public: **********/ /** @ingroup SURF_network_interface * @brief SURF network action interface class - * @details A NetworkAction represents a communication between two [hosts](\ref HostImpl) + * @details A NetworkAction represents a communication between two [hosts](\ref simgrid::surf::HostImpl) */ class NetworkAction : public Action { public: diff --git a/src/surf/plugins/host_dvfs.cpp b/src/surf/plugins/host_dvfs.cpp index b926248075..215336f6b7 100644 --- a/src/surf/plugins/host_dvfs.cpp +++ b/src/surf/plugins/host_dvfs.cpp @@ -187,20 +187,20 @@ public: /** * Add this to your host tag: - * - + * - \ * * Valid values as of now are: performance, powersave, ondemand, conservative * It doesn't matter if you use uppercase or lowercase. * * For the sampling rate, use this: * - * - + * - \ * * This will run the update() method of the specified governor every 2 seconds * on that host. * - * These properties can also be used within the tag to configure - * these values globally. Using them within the will overwrite this + * These properties can also be used within the \ tag to configure + * these values globally. Using them within the \ will overwrite this * global configuration */ class HostDvfs { diff --git a/src/surf/plugins/host_energy.cpp b/src/surf/plugins/host_energy.cpp index b35157c4a4..9bda6091d2 100644 --- a/src/surf/plugins/host_energy.cpp +++ b/src/surf/plugins/host_energy.cpp @@ -45,7 +45,7 @@ AllCores is 200 Watts. This is enough to compute the consumption as a function of the amount of loaded cores: - + diff --git a/src/surf/trace_mgr.cpp b/src/surf/trace_mgr.cpp index 9fd46209b2..944073fa50 100644 --- a/src/surf/trace_mgr.cpp +++ b/src/surf/trace_mgr.cpp @@ -144,7 +144,7 @@ double simgrid::trace_mgr::future_evt_set::next_date() const return heap_.empty() ? -1.0 : heap_.top().first; } -/** @brief Retrieves the next occurring event, or nullptr if none happens before #date */ +/** @brief Retrieves the next occurring event, or nullptr if none happens before date */ tmgr_trace_event_t simgrid::trace_mgr::future_evt_set::pop_leq(double date, double* value, kernel::resource::Resource** resource) { diff --git a/src/surf/trace_mgr.hpp b/src/surf/trace_mgr.hpp index 5b4e174b9f..b1456be7ab 100644 --- a/src/surf/trace_mgr.hpp +++ b/src/surf/trace_mgr.hpp @@ -48,12 +48,12 @@ namespace simgrid { /** @brief Modeling of the availability profile (due to an external load) or the churn * * There is 4 main concepts in this module: - * - #DatedValue: a pair (both are of type double) - * - #trace: a list of dated values - * - #trace_event: links a given trace to a given SimGrid resource. + * - #simgrid::trace_mgr::DatedValue: a pair (both are of type double) + * - #simgrid::trace_mgr::trace: a list of dated values + * - #simgrid::trace_mgr::trace_event: links a given trace to a given SimGrid resource. * A Cpu for example has 2 kinds of events: state (ie, is it ON/OFF) and speed, * while a link has 3 iterators: state, bandwidth and latency. - * - #future_evt_set: makes it easy to find the next occuring event of all traces + * - #simgrid::trace_mgr::future_evt_set: makes it easy to find the next occuring event of all traces */ namespace trace_mgr { class XBT_PUBLIC DatedValue {
#Cores loadedConsumptionExplanation
\#Cores loadedConsumptionExplanation
0 100 WattsIdle value
1 120 WattsOneCore value
2 147 Wattslinear extrapolation between OneCore and AllCores