diff options
| author |  Axel Huebl <axel.huebl@plasma.ninja>
| 2021-10-27 15:55:19 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-10-27 15:55:19 -0700 |
| commit | 2ed3f418ce358e4b7331f2239139a4157ae9382c (patch) | |
| tree | 9fca04d6e0d5c84aa87273ff99655fc645eb43c1 /Source/Particles/Collision/BinaryCollision/BinaryCollision.H | |
| parent | 8fa7cf0e5ed3051466c70ba593b3713b8a61298d (diff) | |
| download | WarpX-2ed3f418ce358e4b7331f2239139a4157ae9382c.tar.gz WarpX-2ed3f418ce358e4b7331f2239139a4157ae9382c.tar.zst WarpX-2ed3f418ce358e4b7331f2239139a4157ae9382c.zip | |
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>
Diffstat (limited to 'Source/Particles/Collision/BinaryCollision/BinaryCollision.H')
| -rw-r--r-- | Source/Particles/Collision/BinaryCollision/BinaryCollision.H | 7 |
1 files changed, 4 insertions, 3 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 |