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

@@ -43,17 +43,17 @@
class CefView;
///
// Implement this interface to handle view events. All size and position values
// are in density independent pixels (DIP) unless otherwise indicated. The
// methods of this class will be called on the browser process UI thread unless
// otherwise indicated.
/// Implement this interface to handle view events. All size and position values
/// are in density independent pixels (DIP) unless otherwise indicated. The
/// methods of this class will be called on the browser process UI thread unless
/// otherwise indicated.
///
/*--cef(source=client)--*/
class CefViewDelegate : public virtual CefBaseRefCounted {
public:
///
// Return the preferred size for |view|. The Layout will use this information
// to determine the display size.
/// Return the preferred size for |view|. The Layout will use this information
/// to determine the display size.
///
/*--cef()--*/
virtual CefSize GetPreferredSize(CefRefPtr<CefView> view) {
@@ -61,22 +61,22 @@ class CefViewDelegate : public virtual CefBaseRefCounted {
}
///
// Return the minimum size for |view|.
/// Return the minimum size for |view|.
///
/*--cef()--*/
virtual CefSize GetMinimumSize(CefRefPtr<CefView> view) { return CefSize(); }
///
// Return the maximum size for |view|.
/// Return the maximum size for |view|.
///
/*--cef()--*/
virtual CefSize GetMaximumSize(CefRefPtr<CefView> view) { return CefSize(); }
///
// Return the height necessary to display |view| with the provided |width|.
// If not specified the result of GetPreferredSize().height will be used by
// default. Override if |view|'s preferred height depends upon the width
// (for example, with Labels).
/// Return the height necessary to display |view| with the provided |width|.
/// If not specified the result of GetPreferredSize().height will be used by
/// default. Override if |view|'s preferred height depends upon the width
/// (for example, with Labels).
///
/*--cef()--*/
virtual int GetHeightForWidth(CefRefPtr<CefView> view, int width) {
@@ -84,11 +84,11 @@ class CefViewDelegate : public virtual CefBaseRefCounted {
}
///
// Called when the parent of |view| has changed. If |view| is being added to
// |parent| then |added| will be true. If |view| is being removed from
// |parent| then |added| will be false. If |view| is being reparented the
// remove notification will be sent before the add notification. Do not modify
// the view hierarchy in this callback.
/// Called when the parent of |view| has changed. If |view| is being added to
/// |parent| then |added| will be true. If |view| is being removed from
/// |parent| then |added| will be false. If |view| is being reparented the
/// remove notification will be sent before the add notification. Do not
/// modify the view hierarchy in this callback.
///
/*--cef()--*/
virtual void OnParentViewChanged(CefRefPtr<CefView> view,
@@ -96,11 +96,11 @@ class CefViewDelegate : public virtual CefBaseRefCounted {
CefRefPtr<CefView> parent) {}
///
// Called when a child of |view| has changed. If |child| is being added to
// |view| then |added| will be true. If |child| is being removed from |view|
// then |added| will be false. If |child| is being reparented the remove
// notification will be sent to the old parent before the add notification is
// sent to the new parent. Do not modify the view hierarchy in this callback.
/// Called when a child of |view| has changed. If |child| is being added to
/// |view| then |added| will be true. If |child| is being removed from |view|
/// then |added| will be false. If |child| is being reparented the remove
/// notification will be sent to the old parent before the add notification is
/// sent to the new parent. Do not modify the view hierarchy in this callback.
///
/*--cef()--*/
virtual void OnChildViewChanged(CefRefPtr<CefView> view,
@@ -108,26 +108,26 @@ class CefViewDelegate : public virtual CefBaseRefCounted {
CefRefPtr<CefView> child) {}
///
// Called when |view| is added or removed from the CefWindow.
/// Called when |view| is added or removed from the CefWindow.
///
/*--cef()--*/
virtual void OnWindowChanged(CefRefPtr<CefView> view, bool added) {}
///
// Called when the layout of |view| has changed.
/// Called when the layout of |view| has changed.
///
/*--cef()--*/
virtual void OnLayoutChanged(CefRefPtr<CefView> view,
const CefRect& new_bounds) {}
///
// Called when |view| gains focus.
/// Called when |view| gains focus.
///
/*--cef()--*/
virtual void OnFocus(CefRefPtr<CefView> view) {}
///
// Called when |view| loses focus.
/// Called when |view| loses focus.
///
/*--cef()--*/
virtual void OnBlur(CefRefPtr<CefView> view) {}