Fix Doxygen warnings

src/core/MpiCallbacks.hpp

@@ -68,10 +68,10 @@ struct callback_concept_t {
 };
 
 /**
- * @brief Concrete implementation of @class callback_concept_t.
+ * @brief Concrete implementation of @ref callback_concept_t.
  *
  * This is an implementation of a callback for a specific callable
- * F and a set of arguments to call it with.
+ * @p F and a set of arguments to call it with.
  */
 template <class F, class... Args>
 struct callback_model_t final : public callback_concept_t {
@@ -129,7 +129,7 @@ auto make_model_impl(CRef &&c, FunctorTypes<C, R, Args...>) {
 }
 
 /**
- * @brief Make a @class callback_model_t for a functor or lambda.
+ * @brief Make a @ref callback_model_t for a functor or lambda.
  *
  * The signature is deduced from F::operator() const, which has
  * to exist and can not be overloaded.
@@ -139,7 +139,7 @@ template <typename F> auto make_model(F &&f) {
 }
 
 /**
- * @brief Make a @class callback_model_t for a function pointer.
+ * @brief Make a @ref callback_model_t for a function pointer.
  *
  * This instantiates a implementation of a callback for a function
  * pointer. The main task here is to transfer the signature from
@@ -319,8 +319,7 @@ class MpiCallbacks {
    * in the MPI loop.
    *
    * @param id The callback to call.
-   * @param par1 First parameter to pass to the callback.
-   * @param par2 Second parameter to pass to the callback.
+   * @param args Arguments for the callback.
    */
   template <class... Args> void call(int id, Args &&... args) const {
     /** Can only be call from master */
@@ -352,7 +351,7 @@ class MpiCallbacks {
    * The method can only be called the master
    * and has the prerequisite that the other nodes are
    * in the MPI loop. Also the function has to be previously
-   * registered e.g. with the @def REGISTER_CALLBACK macro.
+   * registered e.g. with the @ref REGISTER_CALLBACK macro.
    *
    * @param fp Pointer to the function to call.
    * @param args Arguments for the callback.
@@ -446,7 +445,7 @@ using CallbackHandle = MpiCallbacks::CallbackHandle<Args...>;
 /**
  * @brief Helper class to atomatically add callbacks.
  *
- * Should not be used directly, but via @def REGISTER_CALLBACK.
+ * Should not be used directly, but via @ref REGISTER_CALLBACK.
  */
 class RegisterCallback {
 

src/core/debug.hpp

@@ -35,8 +35,7 @@
  */
 void check_particle_consistency();
 
-/** check the consistency of the cells and particle_node. Called from
- *  mpi_bcast_event(CHECK_PARTICLES)
+/** check the consistency of the cells and particle_node.
  */
 void check_particles();
 

src/core/event.hpp

@@ -96,8 +96,8 @@ void on_temperature_change();
 
 /** called every time other parameters (timestep,...) are changed. Note that
  *  this does not happen automatically. The callback procedure of the changed
- *  variable is responsible for that by calling \ref mpi_bcast_event (2).
- *  @param parameter is the FIELD_* identifier of the field changed.
+ *  variable is responsible for that.
+ *  @param parameter is the @ref Fields identifier of the field changed.
  */
 void on_parameter_change(int parameter);
 

src/core/utils/tuple.hpp

@@ -2,7 +2,8 @@
 #define ESPRESSO_TUPLE_HPP
 
 /**
- * @file Algorithms for tuple-like inhomogenous containers.
+ * @file
+ * Algorithms for tuple-like inhomogenous containers.
  */
 
 namespace Utils {
@@ -19,8 +20,8 @@ constexpr decltype(auto) apply_impl(F &&f, Tuple &&t,
  *
  * Like std::apply.
  *
- * @tparam F Callable with tuple elements as agruments
- * @tparam Tuple Has to comform to the tuple interface
+ * @tparam F Callable with tuple elements as arguments
+ * @tparam Tuple Has to conform to the tuple interface
  * @param f
  * @param t
  * @return Whatever @p f returns.