From 76cb6966d0c29034d25be10b5897fa33c3f3aa75 Mon Sep 17 00:00:00 2001
From: Nina Dzugasova <dzugasova.nina@gmail.com>
Date: Wed, 14 Nov 2018 12:02:28 +0100
Subject: [PATCH] Added documentation into file.
---
src/TNL/File.h | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/src/TNL/File.h b/src/TNL/File.h
index 0292466479..8e0836b359 100644
--- a/src/TNL/File.h
+++ b/src/TNL/File.h
@@ -88,6 +88,11 @@ class File
return this->writtenElements;
}
+ /// \brief Function that gets elements from given file.
+ ///
+ /// Returns boolean value based on the succes in reading elements from given file.
+ /// \param buffer Pointer in memory.
+ /// \param elements Number of elements the user wants to get (read) from given file.
template< typename Type, typename Device = Devices::Host, typename Index = int >
bool read( Type* buffer,
const Index& elements );
@@ -96,6 +101,11 @@ class File
template< typename Type, typename Device = Devices::Host >
bool read( Type* buffer );
+ /// \brief Function that writes elements into given file.
+ ///
+ /// Returns boolean value based on the succes in writing elements into given file.
+ /// \param buffer Pointer in memory.
+ /// \param elements Number of elements the user wants to write into the given file.
template< typename Type, typename Device = Devices::Host, typename Index = int >
bool write( const Type* buffer,
const Index elements );
--
GitLab