diff --git a/src/TNL/Containers/List.h b/src/TNL/Containers/List.h index 2f53ccd8cf35152d539a06ac07cc0976ca9bd858..3954b014e121e6a7947f0ad56392ca24feb69dcf 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 c156113f094c84351c6d036a5e7f5ac2c752d071..c6f55ff7622f5784751047fb1d6ed4dad5f2ccb0 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 87298f9e4395a8b8e15ca1eb4b4675a4b8f57530..10ecf800c2bebff4f249b3de7d6b16ba5c786e14 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 3d40bc485a4cc84ce999598498d8b1e24d354dec..1ccc275378a5de5cfe12a2260487d1ad7cf5bae4 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.