From c1a71beb74ef6fe1f28fb9d79caaaf5871c12f0f Mon Sep 17 00:00:00 2001
From: Tomas Oberhuber <tomas.oberhuber@fjfi.cvut.cz>
Date: Wed, 20 Nov 2019 17:03:13 +0100
Subject: [PATCH] Added documentation for template static for-loop.
---
src/TNL/Algorithms/TemplateStaticFor.h | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/src/TNL/Algorithms/TemplateStaticFor.h b/src/TNL/Algorithms/TemplateStaticFor.h
index de6eebbeea..c96c816dc9 100644
--- a/src/TNL/Algorithms/TemplateStaticFor.h
+++ b/src/TNL/Algorithms/TemplateStaticFor.h
@@ -35,6 +35,11 @@ namespace Algorithms {
* \tparam begin the loop iterates over index interval [begin,end).
* \tparam end the loop iterates over index interval [begin,end).
* \tparam LoopBody is a templated class having one template parameter of IndexType.
+ *
+ * \par Example
+ * \include Algorithms/TamplateStaticForExample.cpp
+ * \par Output
+ * \include TamplateStaticForExample.out
*/
template< typename IndexType,
IndexType begin,
@@ -50,6 +55,12 @@ template< typename IndexType,
template< IndexType > class LoopBody >
struct TemplateStaticForExecutor
{
+ /**
+ * \brief Static method initiating the for-loop.
+ *
+ * \tparam Args type of user defined data to be passed to for-loop.
+ * \param args user defined data to be passed to for-loop.
+ */
template< typename... Args >
__cuda_callable__
static void exec( Args&&... args )
--
GitLab