Fix Doxygen: Particles (#2486)

* Fix Doxygen: Particles

Fix doxygen errors & warnings.

* Apply suggestions from code review

Co-authored-by: Luca Fedeli <luca.fedeli@for.unipi.it>
Co-authored-by: Neïl Zaim <49716072+NeilZaim@users.noreply.github.com>

* Apply suggestions from code review

* Document ForwardIterator

* Fix tparam and comma

Co-authored-by: Neïl Zaim <49716072+NeilZaim@users.noreply.github.com>

Co-authored-by: Luca Fedeli <luca.fedeli@for.unipi.it>
Co-authored-by: Neïl Zaim <49716072+NeilZaim@users.noreply.github.com>

3 files changed, 22 insertions, 15 deletions

diff --git a/Source/Particles/Collision/BinaryCollision/BinaryCollision.H b/Source/Particles/Collision/BinaryCollision/BinaryCollision.H
index f85e67901..fa3a0effc 100644
--- a/Source/Particles/Collision/BinaryCollision/BinaryCollision.H
+++ b/Source/Particles/Collision/BinaryCollision/BinaryCollision.H
@@ -79,7 +79,8 @@ public:
     /**
      * \brief Constructor of the BinaryCollision class.
      *
-     * @param collision_name the name of the collision
+     * @param[in] collision_name the name of the collision
+     * @param[in] mypc Container of species involved
      *
      */
     BinaryCollision (std::string collision_name, MultiParticleContainer const * const mypc)
@@ -105,7 +106,6 @@ public:
 
     /** Perform the collisions
      *
-     * @param lev AMR level of the tile
      * @param cur_time Current time
      * @param mypc Container of species involved
      *
@@ -193,7 +193,8 @@ public:
 
     /** Perform all binary collisions within a tile
      *
-     * \param mfi iterator for multifab
+     * \param[in] lev the mesh-refinement level
+     * \param[in] mfi iterator for multifab
      * \param species_1 first species container
      * \param species_2 second species container
      * \param product_species_vector vector of pointers to product species containers
diff --git a/Source/Particles/Collision/BinaryCollision/ElasticCollisionPerez.H b/Source/Particles/Collision/BinaryCollision/ElasticCollisionPerez.H
index bee415860..fd74d3e87 100644
--- a/Source/Particles/Collision/BinaryCollision/ElasticCollisionPerez.H
+++ b/Source/Particles/Collision/BinaryCollision/ElasticCollisionPerez.H
@@ -15,23 +15,26 @@
 #include <AMReX_Random.H>
 
 
-/** \brief Prepare information for and call
- *        UpdateMomentumPerezElastic().
+/** Prepare information for and call UpdateMomentumPerezElastic().
+ *
+ * @tparam T_index type of index arguments
+ * @tparam T_R type of floating point arguments
+ * @tparam SoaData_type type of the "struct of array" for the two involved species
  * @param[in] I1s,I2s is the start index for I1,I2 (inclusive).
  * @param[in] I1e,I2e is the stop index for I1,I2 (exclusive).
- * @param[in] I1 and I2 are the index arrays. They determine all elements that will be used.
- * @param[in,out] u1 and u2 are the velocity arrays (u=v*gamma),
- *                they could be either different or the same,
- *                their lengths are not needed,
- * @param[in] w1 and w2 are arrays of weights.
- * @param[in] q1 and q2 are charges. m1 and m2 are masses.
- * @param[in] T1 and T2 are temperatures (Joule)
+ * @param[in] I1,I2 the index arrays. They determine all elements that will be used.
+ * @param[in,out] soa_1,soa_2 the struct of array for species 1/2
+ * @param[in] q1,q2 charge of species 1/2
+ * @param[in] m1,m2 mass of species 1/2
+ * @param[in] T1 temperature (Joule) of species 1
  *            and will be used if greater than zero,
  *            otherwise will be computed.
+ * @param[in] T2 temperature (Joule) of species 2, @see T1
  * @param[in] dt is the time step length between two collision calls.
  * @param[in] L is the Coulomb log and will be used if greater than zero,
  *            otherwise will be computed.
  * @param[in] dV is the volume of the corresponding cell.
+ * @param[in] engine the random number generator state & factory
 */
 
 template <typename T_index, typename T_R, typename SoaData_type>
diff --git a/Source/Particles/Collision/BinaryCollision/SingleNuclearFusionEvent.H b/Source/Particles/Collision/BinaryCollision/SingleNuclearFusionEvent.H
index c074bb4a4..28030467d 100644
--- a/Source/Particles/Collision/BinaryCollision/SingleNuclearFusionEvent.H
+++ b/Source/Particles/Collision/BinaryCollision/SingleNuclearFusionEvent.H
@@ -26,9 +26,11 @@
  * for that given pair of particles and the weight of the produced particles is stored in
  * p_pair_reaction_weight.
  *
- * @param[in] u1x, u1y, u1z, u2x, u2y and u2z are the momenta of the colliding particles
- * @param[in] m1 and m2 are masses.
- * @param[in] w1 and w2 are the effective weight of the colliding particles
+ * @tparam index_type type of the index argument
+ * @param[in] u1x,u1y,u1z momenta of the first colliding particle
+ * @param[in] u2x,u2y,u2z momenta of the second colliding particle
+ * @param[in] m1,m2 masses
+ * @param[in] w1,w2 effective weight of the colliding particles
  * @param[in] dt is the time step length between two collision calls.
  * @param[in] dV is the volume of the corresponding cell.
  * @param[in] pair_index is the index of the colliding pair
@@ -42,6 +44,7 @@
  * multiplier
  * @param[in] probability_target_value if the probability threshold is exceeded, this is used
  * to determine by how much the fusion multiplier is reduced
+ * @param[in] fusion_type the physical fusion process to model
  * @param[in] engine the random engine.
  */
 template <typename index_type>