Skip to content
Snippets Groups Projects
Commit 76cb6966 authored by Nina Džugasová's avatar Nina Džugasová Committed by Tomáš Oberhuber
Browse files

Added documentation into file.

parent f12bd95c
No related branches found
No related tags found
1 merge request!15Nina
...@@ -88,6 +88,11 @@ class File ...@@ -88,6 +88,11 @@ class File
return this->writtenElements; 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 > template< typename Type, typename Device = Devices::Host, typename Index = int >
bool read( Type* buffer, bool read( Type* buffer,
const Index& elements ); const Index& elements );
...@@ -96,6 +101,11 @@ class File ...@@ -96,6 +101,11 @@ class File
template< typename Type, typename Device = Devices::Host > template< typename Type, typename Device = Devices::Host >
bool read( Type* buffer ); 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 > template< typename Type, typename Device = Devices::Host, typename Index = int >
bool write( const Type* buffer, bool write( const Type* buffer,
const Index elements ); const Index elements );
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment