Skip to content
Snippets Groups Projects
Commit 01221b2f authored by Nina Džugasová's avatar Nina Džugasová
Browse files

Only small adjustments.

parent 4e387085
No related branches found
No related tags found
1 merge request!15Nina
......@@ -112,7 +112,9 @@ template< class T > class List
/// Erases all data elements.
void reset();
/// Erases all data elements with contained data.
/// \brief Erases all data elements with contained data.
///
/// Frees dynamicaly allocated data inside the data elements
void DeepEraseAll();
/// Saves the list in binary format.
......
......@@ -38,6 +38,11 @@ const size_t FileGPUvsCPUTransferBufferSize = 5 * 2<<20;
/// Class file is aimed mainly for the binary data.
///
/// \par Example
/// \include FileExample.cpp
// \par Output
// \include FileExample.out
class File
{
IOMode mode;
......@@ -91,7 +96,7 @@ class File
/// \brief Method that can write particular data type from given file into GPU. (Function that gets particular elements from given file.)
///
/// Returns boolean value based on the succes in reading elements from given file.
/// \param buffer Pointer in memory.
/// \param buffer Pointer in memory (where the read elements are stored?).
/// \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,
......
......@@ -23,7 +23,7 @@ class Logger
/// \brief Basic constructor.
///
/// \param _width Integer that defines the width of logger.
/// \param _stream Where to create the logger, e.g. cout or a certain file.s
/// \param _stream Where to create the logger, e.g. cout or a certain files.
Logger( int _width,
std::ostream& _stream );
......
......@@ -15,7 +15,12 @@ namespace TNL {
class Logger;
/// \brief Class for time measuring
/// \brief Class for time measuring.
///
/// \par Example
/// \include TimerExample.cpp
// \par Output
// \include TimerExample.out
class Timer
{
public:
......@@ -48,7 +53,8 @@ class Timer
/// The timer then continues measuring the time without reseting.
void start();
/// \brief Returs the real (clock/timer) time.
/////
/// \brief Returs the elapsed time on given timer.
///
/// It returns the elapsed time between calling the start() and stop() functions.
/// Starts counting the real time after the function start() is called and
......@@ -61,7 +67,7 @@ class Timer
double getRealTime() const;
/////
/// \brief Returns the CPU time.
/// \brief Returns the elapsed CPU time on given timer.
///
/// CPU time is the time that measures how long it takes processor
/// to complete all computations.
......@@ -78,7 +84,9 @@ class Timer
protected:
/// Function for measuring the real time.
/// \brief Function for measuring the real time.
///
/// Returns the current calendar time.
double readRealTime() const;
/// \brief Function for measuring the CPU time.
......
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