Add missing Doxygen for SYCL functions and some others

[alexxy/gromacs.git] / src / gromacs / mdlib / lincs_gpu_internal.h

diff --git a/src/gromacs/mdlib/lincs_gpu_internal.h b/src/gromacs/mdlib/lincs_gpu_internal.h
index cd421c198c07646d20e45d8ab052cb7915a590ed..db44205fb37af7e80dd6f2ae2392c5b9e9406f92 100644 (file)
--- a/src/gromacs/mdlib/lincs_gpu_internal.h
+++ b/src/gromacs/mdlib/lincs_gpu_internal.h
@@ -57,6 +57,17 @@ struct LincsGpuKernelParameters;
 //! Number of threads in a GPU block
 constexpr static int c_threadsPerBlock = 256;
 
+/*! \brief Backend-specific function to launch LINCS kernel.
+ *
+ * \param kernelParams LINCS parameters.
+ * \param d_x Initial coordinates before the integration.
+ * \param d_xp Coordinates after the integration which will be updated.
+ * \param updateVelocities Whether to also update velocities.
+ * \param d_v Velocities to update (ignored if \p updateVelocities is \c false).
+ * \param invdt Reciprocal of timestep.
+ * \param computeVirial Whether to compute the virial.
+ * \param deviceStream Device stream for kernel launch.
+ */
 void launchLincsGpuKernel(const LincsGpuKernelParameters& kernelParams,
                           const DeviceBuffer<Float3>&     d_x,
                           DeviceBuffer<Float3>            d_xp,