Miscellaneous doxygen fixes
authorArtem Zhmurov <zhmurov@gmail.com>
Thu, 16 Sep 2021 09:43:12 +0000 (12:43 +0300)
committerAndrey Alekseenko <al42and@gmail.com>
Thu, 16 Sep 2021 14:43:12 +0000 (14:43 +0000)
src/gromacs/domdec/domdec.h
src/gromacs/mdlib/lincs.cpp
src/gromacs/mdlib/lincs_gpu.h
src/gromacs/mdtypes/threaded_force_buffer.h
src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel.h
src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel_pruneonly.h

index 3fa388684230a4d90ce1406f56da1b07deb66732..ab5363ce3edb3dfeb4cd3b4825dc39facc8c7982 100644 (file)
@@ -239,12 +239,12 @@ void dd_move_x_and_v_vsites(const gmx_domdec_t& dd, const matrix box, rvec* x, r
  */
 gmx::ArrayRef<const int> dd_constraints_nlocalatoms(const gmx_domdec_t* dd);
 
-/*! Const getter for the local topology checker
+/*! \brief Const getter for the local topology checker
  *
  * \returns Const handle to local topology checker */
 const gmx::LocalTopologyChecker& dd_localTopologyChecker(const gmx_domdec_t& dd);
 
-/*! Getter for the local topology checker
+/*! \brief Getter for the local topology checker
  *
  * \returns Handle to local topology checker */
 gmx::LocalTopologyChecker* dd_localTopologyChecker(gmx_domdec_t* dd);
index 81a0d1173cddc29af1225dbdc7eb78f044be84d3..a6ff2e0477b85831b66ae08caf92b51593bebfe9 100644 (file)
@@ -85,8 +85,6 @@
 #include "gromacs/utility/listoflists.h"
 #include "gromacs/utility/pleasecite.h"
 
-using namespace gmx; // TODO: Remove when this file is moved into gmx namespace
-
 namespace gmx
 {
 
index 5fc68b08d4642ab9e279ffb21211a4c1ce08c273..febb72ab222cdb5405e3db1398f93e8d7ad0f217 100644 (file)
@@ -96,7 +96,7 @@ struct LincsGpuKernelParameters
     DeviceBuffer<AtomPair> d_constraints;
     //! Equilibrium distances for the constraints (GPU)
     DeviceBuffer<float> d_constraintsTargetLengths;
-    /*! Whether there are coupled constraints.
+    /*! \brief Whether there are coupled constraints.
      *
      * In SYCL, the accessors can not be initialized with an empty buffer.
      * In case there are no coupled constraints, the respective buffers below are
index de8eca1abaa7dcb41fd8533198005244288a71b3..f468c1dafef19723413ecf896384340fdc94796e 100644 (file)
@@ -185,7 +185,7 @@ public:
     //! Sets up the reduction, should be called after generating the masks on each thread
     void setupReduction();
 
-    /*! Reduces forces and energies, as requested by \p stepWork
+    /*! \brief Reduces forces and energies, as requested by \p stepWork
      *
      * The reduction of all output starts at the output from thread \p reductionBeginIndex,
      * except for the normal force buffer, which always starts at 0.
index bb256a8482cdb9bb4a56001aebd0d23016ec8ab5..03fc1b6157d38809d9660d00100bf230be5f51c8 100644 (file)
@@ -53,7 +53,7 @@ namespace Nbnxm
 {
 using gmx::InteractionLocality;
 
-/*! Launch SYCL NBNXM kernel.
+/*! \brief Launch SYCL NBNXM kernel.
  *
  * \param nb Non-bonded parameters.
  * \param stepWork Workload flags for the current step.
index da2e96b99673d206594eaac478b1aee8fddd4c53..3508f5606bcb2ecd60068d017e0243ad65d5e052 100644 (file)
@@ -52,7 +52,7 @@ namespace Nbnxm
 {
 using gmx::InteractionLocality;
 
-/*! Launch SYCL NBNXM prune-only kernel.
+/*! \brief Launch SYCL NBNXM prune-only kernel.
  *
  * \param nb Non-bonded parameters.
  * \param iloc Interaction locality.