bcarrella/cef
1
0
Fork 0
mirror of https://bitbucket.org/chromiumembedded/cef synced 2025-06-05 21:39:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

100
include/cef_stream.h
View File

@ -40,197 +40,199 @@
#include "include/cef_base.h"
///
// Interface the client can implement to provide a custom stream reader. The
// methods of this class may be called on any thread.
/// Interface the client can implement to provide a custom stream reader. The
/// methods of this class may be called on any thread.
///
/*--cef(source=client)--*/
class CefReadHandler : public virtual CefBaseRefCounted {
public:
///
// Read raw binary data.
/// Read raw binary data.
///
/*--cef()--*/
virtual size_t Read(void* ptr, size_t size, size_t n) = 0;
///
// Seek to the specified offset position. |whence| may be any one of
// SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on
// failure.
/// Seek to the specified offset position. |whence| may be any one of
/// SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on
/// failure.
///
/*--cef()--*/
virtual int Seek(int64 offset, int whence) = 0;
///
// Return the current offset position.
/// Return the current offset position.
///
/*--cef()--*/
virtual int64 Tell() = 0;
///
// Return non-zero if at end of file.
/// Return non-zero if at end of file.
///
/*--cef()--*/
virtual int Eof() = 0;
///
// Return true if this handler performs work like accessing the file system
// which may block. Used as a hint for determining the thread to access the
// handler from.
/// Return true if this handler performs work like accessing the file system
/// which may block. Used as a hint for determining the thread to access the
/// handler from.
///
/*--cef()--*/
virtual bool MayBlock() = 0;
};
///
// Class used to read data from a stream. The methods of this class may be
// called on any thread.
/// Class used to read data from a stream. The methods of this class may be
/// called on any thread.
///
/*--cef(source=library)--*/
class CefStreamReader : public virtual CefBaseRefCounted {
public:
///
// Create a new CefStreamReader object from a file.
/// Create a new CefStreamReader object from a file.
///
/*--cef()--*/
static CefRefPtr<CefStreamReader> CreateForFile(const CefString& fileName);
///
// Create a new CefStreamReader object from data.
/// Create a new CefStreamReader object from data.
///
/*--cef()--*/
static CefRefPtr<CefStreamReader> CreateForData(void* data, size_t size);
///
// Create a new CefStreamReader object from a custom handler.
/// Create a new CefStreamReader object from a custom handler.
///
/*--cef()--*/
static CefRefPtr<CefStreamReader> CreateForHandler(
CefRefPtr<CefReadHandler> handler);
///
// Read raw binary data.
/// Read raw binary data.
///
/*--cef()--*/
virtual size_t Read(void* ptr, size_t size, size_t n) = 0;
///
// Seek to the specified offset position. |whence| may be any one of
// SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on
// failure.
/// Seek to the specified offset position. |whence| may be any one of
/// SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on
/// failure.
///
/*--cef()--*/
virtual int Seek(int64 offset, int whence) = 0;
///
// Return the current offset position.
/// Return the current offset position.
///
/*--cef()--*/
virtual int64 Tell() = 0;
///
// Return non-zero if at end of file.
/// Return non-zero if at end of file.
///
/*--cef()--*/
virtual int Eof() = 0;
///
// Returns true if this reader performs work like accessing the file system
// which may block. Used as a hint for determining the thread to access the
// reader from.
/// Returns true if this reader performs work like accessing the file system
/// which may block. Used as a hint for determining the thread to access the
/// reader from.
///
/*--cef()--*/
virtual bool MayBlock() = 0;
};
///
// Interface the client can implement to provide a custom stream writer. The
// methods of this class may be called on any thread.
/// Interface the client can implement to provide a custom stream writer. The
/// methods of this class may be called on any thread.
///
/*--cef(source=client)--*/
class CefWriteHandler : public virtual CefBaseRefCounted {
public:
///
// Write raw binary data.
/// Write raw binary data.
///
/*--cef()--*/
virtual size_t Write(const void* ptr, size_t size, size_t n) = 0;
///
// Seek to the specified offset position. |whence| may be any one of
// SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on
// failure.
/// Seek to the specified offset position. |whence| may be any one of
/// SEEK_CUR, SEEK_END or SEEK_SET. Return zero on success and non-zero on
/// failure.
///
/*--cef()--*/
virtual int Seek(int64 offset, int whence) = 0;
///
// Return the current offset position.
/// Return the current offset position.
///
/*--cef()--*/
virtual int64 Tell() = 0;
///
// Flush the stream.
/// Flush the stream.
///
/*--cef()--*/
virtual int Flush() = 0;
///
// Return true if this handler performs work like accessing the file system
// which may block. Used as a hint for determining the thread to access the
// handler from.
/// Return true if this handler performs work like accessing the file system
/// which may block. Used as a hint for determining the thread to access the
/// handler from.
///
/*--cef()--*/
virtual bool MayBlock() = 0;
};
///
// Class used to write data to a stream. The methods of this class may be called
// on any thread.
/// Class used to write data to a stream. The methods of this class may be
/// called on any thread.
///
/*--cef(source=library)--*/
class CefStreamWriter : public virtual CefBaseRefCounted {
public:
///
// Create a new CefStreamWriter object for a file.
/// Create a new CefStreamWriter object for a file.
///
/*--cef()--*/
static CefRefPtr<CefStreamWriter> CreateForFile(const CefString& fileName);
///
// Create a new CefStreamWriter object for a custom handler.
/// Create a new CefStreamWriter object for a custom handler.
///
/*--cef()--*/
static CefRefPtr<CefStreamWriter> CreateForHandler(
CefRefPtr<CefWriteHandler> handler);
///
// Write raw binary data.
/// Write raw binary data.
///
/*--cef()--*/
virtual size_t Write(const void* ptr, size_t size, size_t n) = 0;
///
// Seek to the specified offset position. |whence| may be any one of
// SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on
// failure.
/// Seek to the specified offset position. |whence| may be any one of
/// SEEK_CUR, SEEK_END or SEEK_SET. Returns zero on success and non-zero on
/// failure.
///
/*--cef()--*/
virtual int Seek(int64 offset, int whence) = 0;
///
// Return the current offset position.
/// Return the current offset position.
///
/*--cef()--*/
virtual int64 Tell() = 0;
///
// Flush the stream.
/// Flush the stream.
///
/*--cef()--*/
virtual int Flush() = 0;
///
// Returns true if this writer performs work like accessing the file system
// which may block. Used as a hint for determining the thread to access the
// writer from.
/// Returns true if this writer performs work like accessing the file system
/// which may block. Used as a hint for determining the thread to access the
/// writer from.
///
/*--cef()--*/
virtual bool MayBlock() = 0;