Add missing Doxygen for SYCL functions and some others

[alexxy/gromacs.git] / src / gromacs / gpu_utils / gputraits.h

diff --git a/src/gromacs/gpu_utils/gputraits.h b/src/gromacs/gpu_utils/gputraits.h
index 344b0427c1ae335fd03a69e890e1dd974e9d3ec8..3fb58eb8b43a5c5c6076e547b067feefdf72848d 100644 (file)
--- a/src/gromacs/gpu_utils/gputraits.h
+++ b/src/gromacs/gpu_utils/gputraits.h
@@ -81,6 +81,7 @@ struct Float4
 
 namespace gmx
 {
+//! Reinterpret-cast any pointer \p in to \c Float3, checking the type compatibility.
 template<typename T>
 static inline Float3* asGenericFloat3Pointer(T* in)
 {
@@ -90,6 +91,7 @@ static inline Float3* asGenericFloat3Pointer(T* in)
     return reinterpret_cast<Float3*>(in);
 }
 
+//! Reinterpret-cast any const pointer \p in to \c Float3, checking the type compatibility.
 template<typename T>
 static inline const Float3* asGenericFloat3Pointer(const T* in)
 {
@@ -99,6 +101,7 @@ static inline const Float3* asGenericFloat3Pointer(const T* in)
     return reinterpret_cast<const Float3*>(in);
 }
 
+//! Reinterpret-cast any container \p in to \c Float3, checking the type compatibility.
 template<typename C>
 static inline Float3* asGenericFloat3Pointer(C& in)
 {
@@ -108,6 +111,7 @@ static inline Float3* asGenericFloat3Pointer(C& in)
     return reinterpret_cast<Float3*>(in.data());
 }
 
+//! Reinterpret-cast any const container \p in to \c Float3, checking the type compatibility.
 template<typename C>
 static inline const Float3* asGenericFloat3Pointer(const C& in)
 {