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

46
include/cef_response.h
View File

@ -42,8 +42,8 @@
#include "include/cef_base.h"
///
// Class used to represent a web response. The methods of this class may be
// called on any thread.
/// Class used to represent a web response. The methods of this class may be
/// called on any thread.
///
/*--cef(source=library,no_debugct_check)--*/
class CefResponse : public virtual CefBaseRefCounted {
@ -51,88 +51,88 @@ class CefResponse : public virtual CefBaseRefCounted {
typedef std::multimap<CefString, CefString> HeaderMap;
///
// Create a new CefResponse object.
/// Create a new CefResponse object.
///
/*--cef()--*/
static CefRefPtr<CefResponse> Create();
///
// Returns true if this object is read-only.
/// Returns true if this object is read-only.
///
/*--cef()--*/
virtual bool IsReadOnly() = 0;
///
// Get the response error code. Returns ERR_NONE if there was no error.
/// Get the response error code. Returns ERR_NONE if there was no error.
///
/*--cef(default_retval=ERR_NONE)--*/
virtual cef_errorcode_t GetError() = 0;
///
// Set the response error code. This can be used by custom scheme handlers
// to return errors during initial request processing.
/// Set the response error code. This can be used by custom scheme handlers
/// to return errors during initial request processing.
///
/*--cef()--*/
virtual void SetError(cef_errorcode_t error) = 0;
///
// Get the response status code.
/// Get the response status code.
///
/*--cef()--*/
virtual int GetStatus() = 0;
///
// Set the response status code.
/// Set the response status code.
///
/*--cef()--*/
virtual void SetStatus(int status) = 0;
///
// Get the response status text.
/// Get the response status text.
///
/*--cef()--*/
virtual CefString GetStatusText() = 0;
///
// Set the response status text.
/// Set the response status text.
///
/*--cef(optional_param=statusText)--*/
virtual void SetStatusText(const CefString& statusText) = 0;
///
// Get the response mime type.
/// Get the response mime type.
///
/*--cef()--*/
virtual CefString GetMimeType() = 0;
///
// Set the response mime type.
/// Set the response mime type.
///
/*--cef(optional_param=mimeType)--*/
virtual void SetMimeType(const CefString& mimeType) = 0;
///
// Get the response charset.
/// Get the response charset.
///
/*--cef()--*/
virtual CefString GetCharset() = 0;
///
// Set the response charset.
/// Set the response charset.
///
/*--cef(optional_param=charset)--*/
virtual void SetCharset(const CefString& charset) = 0;
///
// Get the value for the specified response header field.
/// Get the value for the specified response header field.
///
/*--cef()--*/
virtual CefString GetHeaderByName(const CefString& name) = 0;
///
// Set the header |name| to |value|. If |overwrite| is true any existing
// values will be replaced with the new value. If |overwrite| is false any
// existing values will not be overwritten.
/// Set the header |name| to |value|. If |overwrite| is true any existing
/// values will be replaced with the new value. If |overwrite| is false any
/// existing values will not be overwritten.
///
/*--cef(optional_param=value)--*/
virtual void SetHeaderByName(const CefString& name,
@ -140,25 +140,25 @@ class CefResponse : public virtual CefBaseRefCounted {
bool overwrite) = 0;
///
// Get all response header fields.
/// Get all response header fields.
///
/*--cef()--*/
virtual void GetHeaderMap(HeaderMap& headerMap) = 0;
///
// Set all response header fields.
/// Set all response header fields.
///
/*--cef()--*/
virtual void SetHeaderMap(const HeaderMap& headerMap) = 0;
///
// Get the resolved URL after redirects or changed as a result of HSTS.
/// Get the resolved URL after redirects or changed as a result of HSTS.
///
/*--cef()--*/
virtual CefString GetURL() = 0;
///
// Set the resolved URL after redirects or changed as a result of HSTS.
/// Set the resolved URL after redirects or changed as a result of HSTS.
///
/*--cef(optional_param=url)--*/
virtual void SetURL(const CefString& url) = 0;