updating Doxygen after bonds refactoring

espressomd · Mar 17, 2021 · b1b1f44 · b1b1f44
1 parent 212b340
commit b1b1f44
Show file tree

Hide file tree

Showing 5 changed files with 210 additions and 125 deletions.
diff --git a/src/core/bonded_interactions/bonded_interaction_data.cpp b/src/core/bonded_interactions/bonded_interaction_data.cpp
@@ -26,7 +26,6 @@
 #include <algorithm>
 #include <stdexcept>
 
-// std::vector<Bonded_ia_parameters> bonded_ia_params;
 std::vector<Bonded_ia_parameters> bonded_ia_params;
 
 /** Visitor to get the bond cutoff from the bond parameter variant */

diff --git a/src/core/bonded_interactions/bonded_interaction_data.hpp b/src/core/bonded_interactions/bonded_interaction_data.hpp
@@ -65,6 +65,7 @@ struct None_bond_parameters {
   void serialize(Archive &ar, long int /* version */) {}
 };
 
+/** Interaction type for virtual bonds */
 struct VirtualBond_Parameters {
   static constexpr int num = 1;
   double cutoff() const { return -1.; }

diff --git a/src/core/bonded_interactions/bonded_interaction_utils.hpp b/src/core/bonded_interactions/bonded_interaction_utils.hpp
@@ -31,7 +31,8 @@
  *
  *  @param p           particle to check for the bond
  *  @param p_partner   possible bond partner
- *  @param bond_type   enum bond type
+ *  @tparam T          Bond type to check for. Must be of one of the types in
+ *                     @ref Bonded_ia_parameters.
  */
 template <typename T>
 inline bool pair_bond_enum_exists_on(Particle const &p,
@@ -47,7 +48,8 @@ inline bool pair_bond_enum_exists_on(Particle const &p,
  *
  *  @param p1     particle on which the bond may be stored
  *  @param p2     particle on which the bond may be stored
- *  @param bond   numerical bond type
+ *  @tparam T     Bond type to check for. Must be of one of the types in
+ *                @ref Bonded_ia_parameters.
  */
 template <typename T>
 inline bool pair_bond_enum_exists_between(Particle const &p1,