From 89708c206e04ecbdf568f886cb3fe559202239ab Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20Klinkovsk=C3=BD?= <klinkjak@fjfi.cvut.cz>
Date: Wed, 17 Jul 2019 13:20:40 +0200
Subject: [PATCH] Edited documentation for getView methods in Array and Vector
---
src/TNL/Containers/Array.h | 18 +++++++++---------
src/TNL/Containers/ArrayView.h | 20 ++++++++++----------
src/TNL/Containers/Vector.h | 18 +++++++++---------
src/TNL/Containers/VectorView.h | 18 +++++++++---------
src/TNL/TypeTraits.h | 1 +
5 files changed, 38 insertions(+), 37 deletions(-)
diff --git a/src/TNL/Containers/Array.h b/src/TNL/Containers/Array.h
index 27b709671d..7f4d898e9a 100644
--- a/src/TNL/Containers/Array.h
+++ b/src/TNL/Containers/Array.h
@@ -298,9 +298,9 @@ class Array
/**
* \brief Returns a modifiable view of the array.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * array is returned.
+ * By default, a view for the whole array is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the array sub-interval. It is 0 by
* default.
@@ -312,9 +312,9 @@ class Array
/**
* \brief Returns a non-modifiable view of the array.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * array is returned.
+ * By default, a view for the whole array is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the array sub-interval. It is 0 by
* default.
@@ -326,9 +326,9 @@ class Array
/**
* \brief Returns a non-modifiable view of the array.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * array is returned.
+ * By default, a view for the whole array is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the array sub-interval. It is 0 by
* default.
diff --git a/src/TNL/Containers/ArrayView.h b/src/TNL/Containers/ArrayView.h
index 5361b87992..3584efd217 100644
--- a/src/TNL/Containers/ArrayView.h
+++ b/src/TNL/Containers/ArrayView.h
@@ -157,9 +157,9 @@ public:
/**
* \brief Returns a modifiable view of the array view.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * array view is returned.
+ * By default, a view for the whole array is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the array view sub-interval. It is 0 by
* default.
@@ -172,9 +172,9 @@ public:
/**
* \brief Returns a non-modifiable view of the array view.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * array view is returned.
+ * By default, a view for the whole array is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the array view sub-interval. It is 0 by
* default.
@@ -183,13 +183,13 @@ public:
*/
__cuda_callable__
ConstViewType getView( const IndexType begin = 0, IndexType end = 0 ) const;
-
+
/**
* \brief Returns a non-modifiable view of the array view.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * array view is returned.
+ * By default, a view for the whole array is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the array view sub-interval. It is 0 by
* default.
diff --git a/src/TNL/Containers/Vector.h b/src/TNL/Containers/Vector.h
index f5b40e4ba4..e25098a58b 100644
--- a/src/TNL/Containers/Vector.h
+++ b/src/TNL/Containers/Vector.h
@@ -78,9 +78,9 @@ public:
/**
* \brief Returns a modifiable view of the vector.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * vector is returned.
+ * By default, a view for the whole vector is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the vector sub-interval. It is 0 by
* default.
@@ -92,9 +92,9 @@ public:
/**
* \brief Returns a non-modifiable view of the vector.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * vector is returned.
+ * By default, a view for the whole vector is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the vector sub-interval. It is 0 by
* default.
@@ -106,9 +106,9 @@ public:
/**
* \brief Returns a non-modifiable view of the vector.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * vector is returned.
+ * By default, a view for the whole vector is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the vector sub-interval. It is 0 by
* default.
diff --git a/src/TNL/Containers/VectorView.h b/src/TNL/Containers/VectorView.h
index bff31973dc..81f6f50757 100644
--- a/src/TNL/Containers/VectorView.h
+++ b/src/TNL/Containers/VectorView.h
@@ -69,9 +69,9 @@ public:
/**
* \brief Returns a modifiable view of the vector view.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * vector view is returned.
+ * By default, a view for the whole vector is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the vector view sub-interval. It is 0 by
* default.
@@ -84,9 +84,9 @@ public:
/**
* \brief Returns a non-modifiable view of the vector view.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * vector view is returned.
+ * By default, a view for the whole vector is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the vector view sub-interval. It is 0 by
* default.
@@ -99,9 +99,9 @@ public:
/**
* \brief Returns a non-modifiable view of the vector view.
*
- * If \e begin or \e end is set to a non-zero value, a view for the
- * sub-interval `[begin, end)` is returned. Otherwise a view for whole
- * vector view is returned.
+ * By default, a view for the whole vector is returned. If \e begin or
+ * \e end is set to a non-zero value, a view only for the sub-interval
+ * `[begin, end)` is returned.
*
* \param begin The beginning of the vector view sub-interval. It is 0 by
* default.
diff --git a/src/TNL/TypeTraits.h b/src/TNL/TypeTraits.h
index d7a1a4f127..c251dca018 100644
--- a/src/TNL/TypeTraits.h
+++ b/src/TNL/TypeTraits.h
@@ -13,6 +13,7 @@
namespace TNL {
+// TODO: remove - not used anywhere
template< typename T >
struct ViewTypeGetter
{
--
GitLab