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

@@ -45,9 +45,9 @@ class CefBrowser;
class CefBrowserView;
///
// Implement this interface to handle BrowserView events. The methods of this
// class will be called on the browser process UI thread unless otherwise
// indicated.
/// Implement this interface to handle BrowserView events. The methods of this
/// class will be called on the browser process UI thread unless otherwise
/// indicated.
///
/*--cef(source=client)--*/
class CefBrowserViewDelegate : public CefViewDelegate {
@@ -55,31 +55,31 @@ class CefBrowserViewDelegate : public CefViewDelegate {
typedef cef_chrome_toolbar_type_t ChromeToolbarType;
///
// Called when |browser| associated with |browser_view| is created. This
// method will be called after CefLifeSpanHandler::OnAfterCreated() is called
// for |browser| and before OnPopupBrowserViewCreated() is called for
// |browser|'s parent delegate if |browser| is a popup.
/// Called when |browser| associated with |browser_view| is created. This
/// method will be called after CefLifeSpanHandler::OnAfterCreated() is called
/// for |browser| and before OnPopupBrowserViewCreated() is called for
/// |browser|'s parent delegate if |browser| is a popup.
///
/*--cef()--*/
virtual void OnBrowserCreated(CefRefPtr<CefBrowserView> browser_view,
CefRefPtr<CefBrowser> browser) {}
///
// Called when |browser| associated with |browser_view| is destroyed. Release
// all references to |browser| and do not attempt to execute any methods on
// |browser| after this callback returns. This method will be called before
// CefLifeSpanHandler::OnBeforeClose() is called for |browser|.
/// Called when |browser| associated with |browser_view| is destroyed. Release
/// all references to |browser| and do not attempt to execute any methods on
/// |browser| after this callback returns. This method will be called before
/// CefLifeSpanHandler::OnBeforeClose() is called for |browser|.
///
/*--cef()--*/
virtual void OnBrowserDestroyed(CefRefPtr<CefBrowserView> browser_view,
CefRefPtr<CefBrowser> browser) {}
///
// Called before a new popup BrowserView is created. The popup originated
// from |browser_view|. |settings| and |client| are the values returned from
// CefLifeSpanHandler::OnBeforePopup(). |is_devtools| will be true if the
// popup will be a DevTools browser. Return the delegate that will be used for
// the new popup BrowserView.
/// Called before a new popup BrowserView is created. The popup originated
/// from |browser_view|. |settings| and |client| are the values returned from
/// CefLifeSpanHandler::OnBeforePopup(). |is_devtools| will be true if the
/// popup will be a DevTools browser. Return the delegate that will be used
/// for the new popup BrowserView.
///
/*--cef()--*/
virtual CefRefPtr<CefBrowserViewDelegate> GetDelegateForPopupBrowserView(
@@ -91,13 +91,13 @@ class CefBrowserViewDelegate : public CefViewDelegate {
}
///
// Called after |popup_browser_view| is created. This method will be called
// after CefLifeSpanHandler::OnAfterCreated() and OnBrowserCreated() are
// called for the new popup browser. The popup originated from |browser_view|.
// |is_devtools| will be true if the popup is a DevTools browser. Optionally
// add |popup_browser_view| to the views hierarchy yourself and return true.
// Otherwise return false and a default CefWindow will be created for the
// popup.
/// Called after |popup_browser_view| is created. This method will be called
/// after CefLifeSpanHandler::OnAfterCreated() and OnBrowserCreated() are
/// called for the new popup browser. The popup originated from
/// |browser_view|. |is_devtools| will be true if the popup is a DevTools
/// browser. Optionally add |popup_browser_view| to the views hierarchy
/// yourself and return true. Otherwise return false and a default CefWindow
/// will be created for the popup.
///
/*--cef()--*/
virtual bool OnPopupBrowserViewCreated(
@@ -108,9 +108,9 @@ class CefBrowserViewDelegate : public CefViewDelegate {
}
///
// Returns the Chrome toolbar type that will be available via
// CefBrowserView::GetChromeToolbar(). See that method for related
// documentation.
/// Returns the Chrome toolbar type that will be available via
/// CefBrowserView::GetChromeToolbar(). See that method for related
/// documentation.
///
/*--cef(default_retval=CEF_CTT_NONE)--*/
virtual ChromeToolbarType GetChromeToolbarType() { return CEF_CTT_NONE; }