diff options
Diffstat (limited to 'src/OSSupport/GZipFile.h')
| -rw-r--r-- | src/OSSupport/GZipFile.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/OSSupport/GZipFile.h b/src/OSSupport/GZipFile.h index 286c98aff..d1728fd8e 100644 --- a/src/OSSupport/GZipFile.h +++ b/src/OSSupport/GZipFile.h @@ -27,16 +27,16 @@ public: cGZipFile(void); ~cGZipFile(); - /// Opens the file. Returns true if successful. Fails if a file has already been opened through this object. + /** Opens the file. Returns true if successful. Fails if a file has already been opened through this object. */ bool Open(const AString & a_FileName, eMode a_Mode); - /// Closes the file, flushing all buffers. This object may be then reused for a different file and / or mode + /** Closes the file, flushing all buffers. This object may be then reused for a different file and / or mode */ void Close(void); - /// Reads the rest of the file and decompresses it into a_Contents. Returns the number of decompressed bytes, <0 for error + /** Reads the rest of the file and decompresses it into a_Contents. Returns the number of decompressed bytes, <0 for error */ int ReadRestOfFile(AString & a_Contents); - /// Writes a_Contents into file, compressing it along the way. Returns true if successful. Multiple writes are supported. + /** Writes a_Contents into file, compressing it along the way. Returns true if successful. Multiple writes are supported. */ bool Write(const AString & a_Contents) { return Write(a_Contents.data(), static_cast<int>(a_Contents.size())); } bool Write(const char * a_Data, int a_Size); |