From 38e93f30f584c5ee81fddc3483e3302f62917ae7 Mon Sep 17 00:00:00 2001
From: Nina Dzugasova <dzugasova.nina@gmail.com>
Date: Mon, 19 Nov 2018 15:44:10 +0100
Subject: [PATCH] Only small adjustments.
---
src/TNL/Containers/List.h | 4 +++-
src/TNL/File.h | 7 ++++++-
src/TNL/Logger.h | 2 +-
src/TNL/Timer.h | 16 ++++++++++++----
4 files changed, 22 insertions(+), 7 deletions(-)
diff --git a/src/TNL/Containers/List.h b/src/TNL/Containers/List.h
index 2f53ccd8cf..3954b014e1 100644
--- a/src/TNL/Containers/List.h
+++ b/src/TNL/Containers/List.h
@@ -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.
diff --git a/src/TNL/File.h b/src/TNL/File.h
index c156113f09..c6f55ff762 100644
--- a/src/TNL/File.h
+++ b/src/TNL/File.h
@@ -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,
diff --git a/src/TNL/Logger.h b/src/TNL/Logger.h
index 87298f9e43..10ecf800c2 100644
--- a/src/TNL/Logger.h
+++ b/src/TNL/Logger.h
@@ -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 );
diff --git a/src/TNL/Timer.h b/src/TNL/Timer.h
index 3d40bc485a..1ccc275378 100644
--- a/src/TNL/Timer.h
+++ b/src/TNL/Timer.h
@@ -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.
--
GitLab