Update include/ comments to Doxygen formatting (see issue #3384)

See related guidelines in the issue.
This commit is contained in:
Marshall Greenblatt
2022-08-31 22:03:04 -04:00
parent 7b352159df
commit d7a153bdd4
235 changed files with 11484 additions and 11274 deletions

View File

@ -41,97 +41,97 @@
#include "include/cef_stream.h"
///
// Class that supports the reading of zip archives via the zlib unzip API.
// The methods of this class should only be called on the thread that creates
// the object.
/// Class that supports the reading of zip archives via the zlib unzip API.
/// The methods of this class should only be called on the thread that creates
/// the object.
///
/*--cef(source=library)--*/
class CefZipReader : public virtual CefBaseRefCounted {
public:
///
// Create a new CefZipReader object. The returned object's methods can only
// be called from the thread that created the object.
/// Create a new CefZipReader object. The returned object's methods can only
/// be called from the thread that created the object.
///
/*--cef()--*/
static CefRefPtr<CefZipReader> Create(CefRefPtr<CefStreamReader> stream);
///
// Moves the cursor to the first file in the archive. Returns true if the
// cursor position was set successfully.
/// Moves the cursor to the first file in the archive. Returns true if the
/// cursor position was set successfully.
///
/*--cef()--*/
virtual bool MoveToFirstFile() = 0;
///
// Moves the cursor to the next file in the archive. Returns true if the
// cursor position was set successfully.
/// Moves the cursor to the next file in the archive. Returns true if the
/// cursor position was set successfully.
///
/*--cef()--*/
virtual bool MoveToNextFile() = 0;
///
// Moves the cursor to the specified file in the archive. If |caseSensitive|
// is true then the search will be case sensitive. Returns true if the cursor
// position was set successfully.
/// Moves the cursor to the specified file in the archive. If |caseSensitive|
/// is true then the search will be case sensitive. Returns true if the cursor
/// position was set successfully.
///
/*--cef()--*/
virtual bool MoveToFile(const CefString& fileName, bool caseSensitive) = 0;
///
// Closes the archive. This should be called directly to ensure that cleanup
// occurs on the correct thread.
/// Closes the archive. This should be called directly to ensure that cleanup
/// occurs on the correct thread.
///
/*--cef()--*/
virtual bool Close() = 0;
// The below methods act on the file at the current cursor position.
/// The below methods act on the file at the current cursor position.
///
// Returns the name of the file.
/// Returns the name of the file.
///
/*--cef()--*/
virtual CefString GetFileName() = 0;
///
// Returns the uncompressed size of the file.
/// Returns the uncompressed size of the file.
///
/*--cef()--*/
virtual int64 GetFileSize() = 0;
///
// Returns the last modified timestamp for the file.
/// Returns the last modified timestamp for the file.
///
/*--cef()--*/
virtual CefBaseTime GetFileLastModified() = 0;
///
// Opens the file for reading of uncompressed data. A read password may
// optionally be specified.
/// Opens the file for reading of uncompressed data. A read password may
/// optionally be specified.
///
/*--cef(optional_param=password)--*/
virtual bool OpenFile(const CefString& password) = 0;
///
// Closes the file.
/// Closes the file.
///
/*--cef()--*/
virtual bool CloseFile() = 0;
///
// Read uncompressed file contents into the specified buffer. Returns < 0 if
// an error occurred, 0 if at the end of file, or the number of bytes read.
/// Read uncompressed file contents into the specified buffer. Returns < 0 if
/// an error occurred, 0 if at the end of file, or the number of bytes read.
///
/*--cef()--*/
virtual int ReadFile(void* buffer, size_t bufferSize) = 0;
///
// Returns the current offset in the uncompressed file contents.
/// Returns the current offset in the uncompressed file contents.
///
/*--cef()--*/
virtual int64 Tell() = 0;
///
// Returns true if at end of the file contents.
/// Returns true if at end of the file contents.
///
/*--cef()--*/
virtual bool Eof() = 0;