From 4fa5ade7a89d8d75c88ccd77a76e33a301339ba5 Mon Sep 17 00:00:00 2001 From: Artem Zhmurov Date: Thu, 16 Sep 2021 12:43:12 +0300 Subject: [PATCH] Miscellaneous doxygen fixes --- src/gromacs/domdec/domdec.h | 4 ++-- src/gromacs/mdlib/lincs.cpp | 2 -- src/gromacs/mdlib/lincs_gpu.h | 2 +- src/gromacs/mdtypes/threaded_force_buffer.h | 2 +- src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel.h | 2 +- src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel_pruneonly.h | 2 +- 6 files changed, 6 insertions(+), 8 deletions(-) diff --git a/src/gromacs/domdec/domdec.h b/src/gromacs/domdec/domdec.h index 3fa3886842..ab5363ce3e 100644 --- a/src/gromacs/domdec/domdec.h +++ b/src/gromacs/domdec/domdec.h @@ -239,12 +239,12 @@ void dd_move_x_and_v_vsites(const gmx_domdec_t& dd, const matrix box, rvec* x, r */ gmx::ArrayRef 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); diff --git a/src/gromacs/mdlib/lincs.cpp b/src/gromacs/mdlib/lincs.cpp index 81a0d1173c..a6ff2e0477 100644 --- a/src/gromacs/mdlib/lincs.cpp +++ b/src/gromacs/mdlib/lincs.cpp @@ -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 { diff --git a/src/gromacs/mdlib/lincs_gpu.h b/src/gromacs/mdlib/lincs_gpu.h index 5fc68b08d4..febb72ab22 100644 --- a/src/gromacs/mdlib/lincs_gpu.h +++ b/src/gromacs/mdlib/lincs_gpu.h @@ -96,7 +96,7 @@ struct LincsGpuKernelParameters DeviceBuffer d_constraints; //! Equilibrium distances for the constraints (GPU) DeviceBuffer 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 diff --git a/src/gromacs/mdtypes/threaded_force_buffer.h b/src/gromacs/mdtypes/threaded_force_buffer.h index de8eca1aba..f468c1dafe 100644 --- a/src/gromacs/mdtypes/threaded_force_buffer.h +++ b/src/gromacs/mdtypes/threaded_force_buffer.h @@ -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. diff --git a/src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel.h b/src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel.h index bb256a8482..03fc1b6157 100644 --- a/src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel.h +++ b/src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel.h @@ -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. diff --git a/src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel_pruneonly.h b/src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel_pruneonly.h index da2e96b996..3508f5606b 100644 --- a/src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel_pruneonly.h +++ b/src/gromacs/nbnxm/sycl/nbnxm_sycl_kernel_pruneonly.h @@ -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. -- 2.22.0