mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
@ -43,9 +43,9 @@
|
||||
#include "include/cef_frame.h"
|
||||
|
||||
///
|
||||
// Implement this interface to handle events related to browser load status. The
|
||||
// methods of this class will be called on the browser process UI thread or
|
||||
// render process main thread (TID_RENDERER).
|
||||
/// Implement this interface to handle events related to browser load status.
|
||||
/// The methods of this class will be called on the browser process UI thread or
|
||||
/// render process main thread (TID_RENDERER).
|
||||
///
|
||||
/*--cef(source=client)--*/
|
||||
class CefLoadHandler : public virtual CefBaseRefCounted {
|
||||
@ -54,11 +54,11 @@ class CefLoadHandler : public virtual CefBaseRefCounted {
|
||||
typedef cef_transition_type_t TransitionType;
|
||||
|
||||
///
|
||||
// Called when the loading state has changed. This callback will be executed
|
||||
// twice -- once when loading is initiated either programmatically or by user
|
||||
// action, and once when loading is terminated due to completion, cancellation
|
||||
// of failure. It will be called before any calls to OnLoadStart and after all
|
||||
// calls to OnLoadError and/or OnLoadEnd.
|
||||
/// Called when the loading state has changed. This callback will be executed
|
||||
/// twice -- once when loading is initiated either programmatically or by user
|
||||
/// action, and once when loading is terminated due to completion,
|
||||
/// cancellation of failure. It will be called before any calls to OnLoadStart
|
||||
/// and after all calls to OnLoadError and/or OnLoadEnd.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnLoadingStateChange(CefRefPtr<CefBrowser> browser,
|
||||
@ -67,16 +67,16 @@ class CefLoadHandler : public virtual CefBaseRefCounted {
|
||||
bool canGoForward) {}
|
||||
|
||||
///
|
||||
// Called after a navigation has been committed and before the browser begins
|
||||
// loading contents in the frame. The |frame| value will never be empty --
|
||||
// call the IsMain() method to check if this frame is the main frame.
|
||||
// |transition_type| provides information about the source of the navigation
|
||||
// and an accurate value is only available in the browser process. Multiple
|
||||
// frames may be loading at the same time. Sub-frames may start or continue
|
||||
// loading after the main frame load has ended. This method will not be called
|
||||
// for same page navigations (fragments, history state, etc.) or for
|
||||
// navigations that fail or are canceled before commit. For notification of
|
||||
// overall browser load status use OnLoadingStateChange instead.
|
||||
/// Called after a navigation has been committed and before the browser begins
|
||||
/// loading contents in the frame. The |frame| value will never be empty --
|
||||
/// call the IsMain() method to check if this frame is the main frame.
|
||||
/// |transition_type| provides information about the source of the navigation
|
||||
/// and an accurate value is only available in the browser process. Multiple
|
||||
/// frames may be loading at the same time. Sub-frames may start or continue
|
||||
/// loading after the main frame load has ended. This method will not be
|
||||
/// called for same page navigations (fragments, history state, etc.) or for
|
||||
/// navigations that fail or are canceled before commit. For notification of
|
||||
/// overall browser load status use OnLoadingStateChange instead.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnLoadStart(CefRefPtr<CefBrowser> browser,
|
||||
@ -84,14 +84,14 @@ class CefLoadHandler : public virtual CefBaseRefCounted {
|
||||
TransitionType transition_type) {}
|
||||
|
||||
///
|
||||
// Called when the browser is done loading a frame. The |frame| value will
|
||||
// never be empty -- call the IsMain() method to check if this frame is the
|
||||
// main frame. Multiple frames may be loading at the same time. Sub-frames may
|
||||
// start or continue loading after the main frame load has ended. This method
|
||||
// will not be called for same page navigations (fragments, history state,
|
||||
// etc.) or for navigations that fail or are canceled before commit. For
|
||||
// notification of overall browser load status use OnLoadingStateChange
|
||||
// instead.
|
||||
/// Called when the browser is done loading a frame. The |frame| value will
|
||||
/// never be empty -- call the IsMain() method to check if this frame is the
|
||||
/// main frame. Multiple frames may be loading at the same time. Sub-frames
|
||||
/// may start or continue loading after the main frame load has ended. This
|
||||
/// method will not be called for same page navigations (fragments, history
|
||||
/// state, etc.) or for navigations that fail or are canceled before commit.
|
||||
/// For notification of overall browser load status use OnLoadingStateChange
|
||||
/// instead.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnLoadEnd(CefRefPtr<CefBrowser> browser,
|
||||
@ -99,11 +99,12 @@ class CefLoadHandler : public virtual CefBaseRefCounted {
|
||||
int httpStatusCode) {}
|
||||
|
||||
///
|
||||
// Called when a navigation fails or is canceled. This method may be called
|
||||
// by itself if before commit or in combination with OnLoadStart/OnLoadEnd if
|
||||
// after commit. |errorCode| is the error code number, |errorText| is the
|
||||
// error text and |failedUrl| is the URL that failed to load.
|
||||
// See net\base\net_error_list.h for complete descriptions of the error codes.
|
||||
/// Called when a navigation fails or is canceled. This method may be called
|
||||
/// by itself if before commit or in combination with OnLoadStart/OnLoadEnd if
|
||||
/// after commit. |errorCode| is the error code number, |errorText| is the
|
||||
/// error text and |failedUrl| is the URL that failed to load.
|
||||
/// See net\base\net_error_list.h for complete descriptions of the error
|
||||
/// codes.
|
||||
///
|
||||
/*--cef(optional_param=errorText)--*/
|
||||
virtual void OnLoadError(CefRefPtr<CefBrowser> browser,
|
||||
|
Reference in New Issue
Block a user