Fix doxygen for unused parameters.

Recent addition to the code didn't use the parameters for the SYCL
stubs, leading to errors from doxygen.

Change-Id: I61666e4e76cfdcfa5c618c7bc6f58cf24ea2b4f8

diff --git a/src/gromacs/gpu_utils/devicebuffer_sycl.h b/src/gromacs/gpu_utils/devicebuffer_sycl.h
index a7a1b500ec80260ad928fcb2b70aae95fe767f88..bb2bc118fc2adaac22b82b28a0bdac7ba633a6ad 100644 (file)
--- a/src/gromacs/gpu_utils/devicebuffer_sycl.h
+++ b/src/gromacs/gpu_utils/devicebuffer_sycl.h
@@ -58,9 +58,9 @@
  * It is currently a caller's responsibility to call it only on not-yet allocated buffers.
  *
  * \tparam        ValueType            Raw value type of the \p buffer.
- * \param[in,out] buffer               Pointer to the device-side buffer.
- * \param[in]     numValues            Number of values to accomodate.
- * \param[in]     deviceContext        The buffer's device context-to-be.
+ * param[in,out] buffer               Pointer to the device-side buffer.
+ * param[in]     numValues            Number of values to accomodate.
+ * param[in]     deviceContext        The buffer's device context-to-be.
  */
 template<typename ValueType>
 void allocateDeviceBuffer(DeviceBuffer<ValueType>* /* buffer */,
@@ -76,7 +76,7 @@ void allocateDeviceBuffer(DeviceBuffer<ValueType>* /* buffer */,
  * as this is planned to be a destructor of DeviceBuffer as a proper class,
  * and no calls on \p buffer should be made afterwards.
  *
- * \param[in] buffer  Pointer to the buffer to free.
+ * param[in] buffer  Pointer to the buffer to free.
  */
 template<typename DeviceBuffer>
 void freeDeviceBuffer(DeviceBuffer* /* buffer */)
@@ -91,13 +91,13 @@ void freeDeviceBuffer(DeviceBuffer* /* buffer */)
  * because of the early return.
  *
  * \tparam        ValueType            Raw value type of the \p buffer.
- * \param[in,out] buffer               Pointer to the device-side buffer
- * \param[in]     hostBuffer           Pointer to the raw host-side memory, also typed \p ValueType
- * \param[in]     startingOffset       Offset (in values) at the device-side buffer to copy into.
- * \param[in]     numValues            Number of values to copy.
- * \param[in]     deviceStream         GPU stream to perform asynchronous copy in.
- * \param[in]     transferKind         Copy type: synchronous or asynchronous.
- * \param[out]    timingEvent          A pointer to the H2D copy timing event to be filled in.
+ * param[in,out] buffer               Pointer to the device-side buffer
+ * param[in]     hostBuffer           Pointer to the raw host-side memory, also typed \p ValueType
+ * param[in]     startingOffset       Offset (in values) at the device-side buffer to copy into.
+ * param[in]     numValues            Number of values to copy.
+ * param[in]     deviceStream         GPU stream to perform asynchronous copy in.
+ * param[in]     transferKind         Copy type: synchronous or asynchronous.
+ * param[out]    timingEvent          A pointer to the H2D copy timing event to be filled in.
  *                                     If the pointer is not null, the event can further be used
  *                                     to queue a wait for this operation or to query profiling information.
  */
@@ -120,13 +120,13 @@ void copyToDeviceBuffer(DeviceBuffer<ValueType>* /* buffer */,
  * because of the early return.
  *
  * \tparam        ValueType            Raw value type of the \p buffer.
- * \param[in,out] hostBuffer           Pointer to the raw host-side memory, also typed \p ValueType
- * \param[in]     buffer               Pointer to the device-side buffer
- * \param[in]     startingOffset       Offset (in values) at the device-side buffer to copy from.
- * \param[in]     numValues            Number of values to copy.
- * \param[in]     deviceStream         GPU stream to perform asynchronous copy in.
- * \param[in]     transferKind         Copy type: synchronous or asynchronous.
- * \param[out]    timingEvent          A pointer to the H2D copy timing event to be filled in.
+ * param[in,out] hostBuffer           Pointer to the raw host-side memory, also typed \p ValueType
+ * param[in]     buffer               Pointer to the device-side buffer
+ * param[in]     startingOffset       Offset (in values) at the device-side buffer to copy from.
+ * param[in]     numValues            Number of values to copy.
+ * param[in]     deviceStream         GPU stream to perform asynchronous copy in.
+ * param[in]     transferKind         Copy type: synchronous or asynchronous.
+ * param[out]    timingEvent          A pointer to the H2D copy timing event to be filled in.
  *                                     If the pointer is not null, the event can further be used
  *                                     to queue a wait for this operation or to query profiling information.
  */
@@ -146,10 +146,10 @@ void copyFromDeviceBuffer(ValueType* /* hostBuffer */,
  * Clears the device buffer asynchronously.
  *
  * \tparam        ValueType       Raw value type of the \p buffer.
- * \param[in,out] buffer          Pointer to the device-side buffer
- * \param[in]     startingOffset  Offset (in values) at the device-side buffer to start clearing at.
- * \param[in]     numValues       Number of values to clear.
- * \param[in]     deviceStream    GPU stream.
+ * param[in,out] buffer          Pointer to the device-side buffer
+ * param[in]     startingOffset  Offset (in values) at the device-side buffer to start clearing at.
+ * param[in]     numValues       Number of values to clear.
+ * param[in]     deviceStream    GPU stream.
  */
 template<typename ValueType>
 void clearDeviceBufferAsync(DeviceBuffer<ValueType>* /* buffer */,
@@ -164,8 +164,8 @@ void clearDeviceBufferAsync(DeviceBuffer<ValueType>* /* buffer */,
  *
  * Checks if the buffer is not nullptr and if its allocation is big enough.
  *
- * \param[in] buffer        Device buffer to be checked.
- * \param[in] requiredSize  Number of elements that the buffer will have to accommodate.
+ * param[in] buffer        Device buffer to be checked.
+ * param[in] requiredSize  Number of elements that the buffer will have to accommodate.
  *
  * \returns Whether the device buffer can be set.
  */
@@ -186,10 +186,10 @@ using DeviceTexture = void*;
  *
  * \tparam      ValueType      Raw data type.
  *
- * \param[out]  deviceBuffer   Device buffer to store data in.
- * \param[in]   hostBuffer     Host buffer to get date from.
- * \param[in]   numValues      Number of elements in the buffer.
- * \param[in]   deviceContext  GPU device context.
+ * param[out]  deviceBuffer   Device buffer to store data in.
+ * param[in]   hostBuffer     Host buffer to get date from.
+ * param[in]   numValues      Number of elements in the buffer.
+ * param[in]   deviceContext  GPU device context.
  */
 template<typename ValueType>
 void initParamLookupTable(DeviceBuffer<ValueType>* /* deviceBuffer */,
@@ -205,7 +205,7 @@ void initParamLookupTable(DeviceBuffer<ValueType>* /* deviceBuffer */,
  *
  * \tparam        ValueType     Raw data type.
  *
- * \param[in,out] deviceBuffer  Device buffer to store data in.
+ * param[in,out] deviceBuffer  Device buffer to store data in.
  */
 template<typename ValueType>
 void destroyParamLookupTable(DeviceBuffer<ValueType>* /* deviceBuffer */, DeviceTexture& /* deviceTexture*/)

diff --git a/src/gromacs/gpu_utils/gpueventsynchronizer.cuh b/src/gromacs/gpu_utils/gpueventsynchronizer.cuh
index c33d3fb4792fced9467805ed63753c0a61ecb066..14c3ac93cc2a9bc2c9f44333b141090eb2f6f401 100644 (file)
--- a/src/gromacs/gpu_utils/gpueventsynchronizer.cuh
+++ b/src/gromacs/gpu_utils/gpueventsynchronizer.cuh
@@ -45,6 +45,8 @@
 #include "gromacs/gpu_utils/gputraits.cuh"
 #include "gromacs/utility/gmxassert.h"
 
+#ifndef DOXYGEN
+
 /*! \libinternal \brief
  * A class which allows for CPU thread to mark and wait for certain GPU stream execution point.
  * The event can be put into the stream with markEvent() and then later waited on with waitForEvent().
@@ -104,3 +106,5 @@ private:
 };
 
 #endif
+
+#endif

diff --git a/src/gromacs/gpu_utils/gpueventsynchronizer_ocl.h b/src/gromacs/gpu_utils/gpueventsynchronizer_ocl.h
index 9a62b5b6d47efdab66a56cdfa91377d93ae58501..9d8ee3f2c70f52bb9865e5f4ec8a623895cafff9 100644 (file)
--- a/src/gromacs/gpu_utils/gpueventsynchronizer_ocl.h
+++ b/src/gromacs/gpu_utils/gpueventsynchronizer_ocl.h
@@ -41,10 +41,12 @@
 #ifndef GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_OCL_H
 #define GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_OCL_H
 
-#include "gromacs/gpu_utils/gputraits_ocl.h"
-#include "gromacs/gpu_utils/oclutils.h"
-#include "gromacs/utility/exceptions.h"
-#include "gromacs/utility/gmxassert.h"
+#ifndef DOXYGEN
+
+#    include "gromacs/gpu_utils/gputraits_ocl.h"
+#    include "gromacs/gpu_utils/oclutils.h"
+#    include "gromacs/utility/exceptions.h"
+#    include "gromacs/utility/gmxassert.h"
 
 /*! \libinternal \brief
  * A class which allows for CPU thread to mark and wait for certain GPU stream execution point.
@@ -142,3 +144,5 @@ private:
 };
 
 #endif
+
+#endif

diff --git a/src/gromacs/gpu_utils/gpueventsynchronizer_sycl.h b/src/gromacs/gpu_utils/gpueventsynchronizer_sycl.h
index faf34dfda9d51473081e4579b9d22691fb55603f..f22e3208e08c29c491154122c675679c9192149f 100644 (file)
--- a/src/gromacs/gpu_utils/gpueventsynchronizer_sycl.h
+++ b/src/gromacs/gpu_utils/gpueventsynchronizer_sycl.h
@@ -41,8 +41,10 @@
 #ifndef GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_OCL_H
 #define GMX_GPU_UTILS_GPUEVENTSYNCHRONIZER_OCL_H
 
-#include "gromacs/utility/exceptions.h"
-#include "gromacs/utility/gmxassert.h"
+#ifndef DOXYGEN
+
+#    include "gromacs/utility/exceptions.h"
+#    include "gromacs/utility/gmxassert.h"
 
 /*! \libinternal \brief
  * A class which allows for CPU thread to mark and wait for certain GPU stream execution point.
@@ -98,3 +100,5 @@ private:
 };
 
 #endif
+
+#endif