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

88
include/cef_devtools_message_observer.h
View File

@ -43,32 +43,33 @@
class CefBrowser;
///
// Callback interface for CefBrowserHost::AddDevToolsMessageObserver. The
// methods of this class will be called on the browser process UI thread.
/// Callback interface for CefBrowserHost::AddDevToolsMessageObserver. The
/// methods of this class will be called on the browser process UI thread.
///
/*--cef(source=client)--*/
class CefDevToolsMessageObserver : public virtual CefBaseRefCounted {
public:
///
// Method that will be called on receipt of a DevTools protocol message.
// |browser| is the originating browser instance. |message| is a UTF8-encoded
// JSON dictionary representing either a method result or an event. |message|
// is only valid for the scope of this callback and should be copied if
// necessary. Return true if the message was handled or false if the message
// should be further processed and passed to the OnDevToolsMethodResult or
// OnDevToolsEvent methods as appropriate.
//
// Method result dictionaries include an "id" (int) value that identifies the
// orginating method call sent from CefBrowserHost::SendDevToolsMessage, and
// optionally either a "result" (dictionary) or "error" (dictionary) value.
// The "error" dictionary will contain "code" (int) and "message" (string)
// values. Event dictionaries include a "method" (string) value and optionally
// a "params" (dictionary) value. See the DevTools protocol documentation at
// https://chromedevtools.github.io/devtools-protocol/ for details of
// supported method calls and the expected "result" or "params" dictionary
// contents. JSON dictionaries can be parsed using the CefParseJSON function
// if desired, however be aware of performance considerations when parsing
// large messages (some of which may exceed 1MB in size).
/// Method that will be called on receipt of a DevTools protocol message.
/// |browser| is the originating browser instance. |message| is a UTF8-encoded
/// JSON dictionary representing either a method result or an event. |message|
/// is only valid for the scope of this callback and should be copied if
/// necessary. Return true if the message was handled or false if the message
/// should be further processed and passed to the OnDevToolsMethodResult or
/// OnDevToolsEvent methods as appropriate.
///
/// Method result dictionaries include an "id" (int) value that identifies the
/// orginating method call sent from CefBrowserHost::SendDevToolsMessage, and
/// optionally either a "result" (dictionary) or "error" (dictionary) value.
/// The "error" dictionary will contain "code" (int) and "message" (string)
/// values. Event dictionaries include a "method" (string) value and
/// optionally a "params" (dictionary) value. See the DevTools protocol
/// documentation at https://chromedevtools.github.io/devtools-protocol/ for
/// details of supported method calls and the expected "result" or "params"
/// dictionary contents. JSON dictionaries can be parsed using the
/// CefParseJSON function if desired, however be aware of performance
/// considerations when parsing large messages (some of which may exceed 1MB
/// in size).
///
/*--cef()--*/
virtual bool OnDevToolsMessage(CefRefPtr<CefBrowser> browser,
@ -78,15 +79,16 @@ class CefDevToolsMessageObserver : public virtual CefBaseRefCounted {
}
///
// Method that will be called after attempted execution of a DevTools protocol
// method. |browser| is the originating browser instance. |message_id| is the
// "id" value that identifies the originating method call message. If the
// method succeeded |success| will be true and |result| will be the
// UTF8-encoded JSON "result" dictionary value (which may be empty). If the
// method failed |success| will be false and |result| will be the UTF8-encoded
// JSON "error" dictionary value. |result| is only valid for the scope of this
// callback and should be copied if necessary. See the OnDevToolsMessage
// documentation for additional details on |result| contents.
/// Method that will be called after attempted execution of a DevTools
/// protocol method. |browser| is the originating browser instance.
/// |message_id| is the "id" value that identifies the originating method call
/// message. If the method succeeded |success| will be true and |result| will
/// be the UTF8-encoded JSON "result" dictionary value (which may be empty).
/// If the method failed |success| will be false and |result| will be the
/// UTF8-encoded JSON "error" dictionary value. |result| is only valid for the
/// scope of this callback and should be copied if necessary. See the
/// OnDevToolsMessage documentation for additional details on |result|
/// contents.
///
/*--cef(optional_param=result)--*/
virtual void OnDevToolsMethodResult(CefRefPtr<CefBrowser> browser,
@ -96,12 +98,12 @@ class CefDevToolsMessageObserver : public virtual CefBaseRefCounted {
size_t result_size) {}
///
// Method that will be called on receipt of a DevTools protocol event.
// |browser| is the originating browser instance. |method| is the "method"
// value. |params| is the UTF8-encoded JSON "params" dictionary value (which
// may be empty). |params| is only valid for the scope of this callback and
// should be copied if necessary. See the OnDevToolsMessage documentation for
// additional details on |params| contents.
/// Method that will be called on receipt of a DevTools protocol event.
/// |browser| is the originating browser instance. |method| is the "method"
/// value. |params| is the UTF8-encoded JSON "params" dictionary value (which
/// may be empty). |params| is only valid for the scope of this callback and
/// should be copied if necessary. See the OnDevToolsMessage documentation for
/// additional details on |params| contents.
///
/*--cef(optional_param=params)--*/
virtual void OnDevToolsEvent(CefRefPtr<CefBrowser> browser,
@ -110,18 +112,18 @@ class CefDevToolsMessageObserver : public virtual CefBaseRefCounted {
size_t params_size) {}
///
// Method that will be called when the DevTools agent has attached. |browser|
// is the originating browser instance. This will generally occur in response
// to the first message sent while the agent is detached.
/// Method that will be called when the DevTools agent has attached. |browser|
/// is the originating browser instance. This will generally occur in response
/// to the first message sent while the agent is detached.
///
/*--cef()--*/
virtual void OnDevToolsAgentAttached(CefRefPtr<CefBrowser> browser) {}
///
// Method that will be called when the DevTools agent has detached. |browser|
// is the originating browser instance. Any method results that were pending
// before the agent became detached will not be delivered, and any active
// event subscriptions will be canceled.
/// Method that will be called when the DevTools agent has detached. |browser|
/// is the originating browser instance. Any method results that were pending
/// before the agent became detached will not be delivered, and any active
/// event subscriptions will be canceled.
///
/*--cef()--*/
virtual void OnDevToolsAgentDetached(CefRefPtr<CefBrowser> browser) {}