Commit f7e026d8 authored by Nina Džugasová's avatar Nina Džugasová Committed by Tomáš Oberhuber
Browse files

Started documentation of File.

parent c144d985

src/TNL/File.h

+12 −3
Original line number Diff line number Diff line
@@ -36,9 +36,8 @@ enum class IOMode 
 */

const size_t FileGPUvsCPUTransferBufferSize = 5 * 2<<20;



/*

 * This file is aimed mainly for the binary data. It supports transparent compression.

 */



/// Class file is aimed mainly for the binary data. It supports transparent compression.

class File

{

   IOMode mode;
@@ -55,10 +54,19 @@ class File 


   public:



   /// Basic constructor.

   File();



   /// Destructor.

   ~File();



   /////

   /// \brief Opens given file. 

   ///

   /// Opens file with given \e fileName and returns true/false based on the success in opening the file.

   /// \param fileName String which indicates name of the file user wants to open.

   /// \param mode Indicates what user needs to do with opened file.

   /// Modes to choose: IOMode::read or IOMode::write.

   bool open( const String& fileName,

              const IOMode mode );
@@ -92,6 +100,7 @@ class File 
   template< typename Type, typename Device = Devices::Host >

   bool write( const Type* buffer );



   /// \brief Closes given file and returns true/false based on the success in closing the file.

   bool close();



protected:

src/TNL/Timer.h

+3 −3
Original line number Diff line number Diff line
@@ -66,10 +66,10 @@ class Timer 
 

   protected:



      /// Function for reading the real time from timer.

      /// Function for reading the real time.

      double readRealTime() const;



      /// \brief Function for reading the CPU time from timer.

      /// \brief Function for reading the CPU time.

      ///

      /// CPU time is the time that measures how long it takes processor

      /// to complete all computations.