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

30
include/cef_base.h
View File

@ -48,29 +48,29 @@
#endif
///
// All ref-counted framework classes must extend this class.
/// All ref-counted framework classes must extend this class.
///
class CefBaseRefCounted {
public:
///
// Called to increment the reference count for the object. Should be called
// for every new copy of a pointer to a given object.
/// Called to increment the reference count for the object. Should be called
/// for every new copy of a pointer to a given object.
///
virtual void AddRef() const = 0;
///
// Called to decrement the reference count for the object. Returns true if
// the reference count is 0, in which case the object should self-delete.
/// Called to decrement the reference count for the object. Returns true if
/// the reference count is 0, in which case the object should self-delete.
///
virtual bool Release() const = 0;
///
// Returns true if the reference count is 1.
/// Returns true if the reference count is 1.
///
virtual bool HasOneRef() const = 0;
///
// Returns true if the reference count is at least 1.
/// Returns true if the reference count is at least 1.
///
virtual bool HasAtLeastOneRef() const = 0;
@ -79,7 +79,7 @@ class CefBaseRefCounted {
};
///
// All scoped framework classes must extend this class.
/// All scoped framework classes must extend this class.
///
class CefBaseScoped {
public:
@ -87,7 +87,7 @@ class CefBaseScoped {
};
///
// Class that implements atomic reference counting.
/// Class that implements atomic reference counting.
///
class CefRefCount {
public:
@ -97,22 +97,22 @@ class CefRefCount {
CefRefCount& operator=(const CefRefCount&) = delete;
///
// Increment the reference count.
/// Increment the reference count.
///
void AddRef() const { ref_count_.Increment(); }
///
// Decrement the reference count. Returns true if the reference count is 0.
/// Decrement the reference count. Returns true if the reference count is 0.
///
bool Release() const { return !ref_count_.Decrement(); }
///
// Returns true if the reference count is 1.
/// Returns true if the reference count is 1.
///
bool HasOneRef() const { return ref_count_.IsOne(); }
///
// Returns true if the reference count is at least 1.
/// Returns true if the reference count is at least 1.
///
bool HasAtLeastOneRef() const { return !ref_count_.IsZero(); }
@ -121,8 +121,8 @@ class CefRefCount {
};
///
// Macro that provides a reference counting implementation for classes extending
// CefBase.
/// Macro that provides a reference counting implementation for classes
/// extending CefBase.
///
#define IMPLEMENT_REFCOUNTING(ClassName) \
public: \