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

@ -55,26 +55,29 @@
DCHECK(CefCurrentlyOn(TID_FILE_USER_BLOCKING));
#define CEF_REQUIRE_RENDERER_THREAD() DCHECK(CefCurrentlyOn(TID_RENDERER));
// Use this struct in conjuction with refcounted types to ensure that an
// object is deleted on the specified thread. For example:
//
// class Foo : public base::RefCountedThreadSafe<Foo, CefDeleteOnUIThread> {
// public:
// Foo();
// void DoSomething();
//
// private:
// // Allow deletion via scoped_refptr only.
// friend struct CefDeleteOnThread<TID_UI>;
// friend class base::RefCountedThreadSafe<Foo, CefDeleteOnUIThread>;
//
// virtual ~Foo() {}
// };
//
// base::scoped_refptr<Foo> foo = new Foo();
// foo->DoSomething();
// foo = NULL; // Deletion of |foo| will occur on the UI thread.
//
///
/// Use this struct in conjuction with refcounted types to ensure that an
/// object is deleted on the specified thread. For example:
///
/// <pre>
/// class Foo : public base::RefCountedThreadSafe<Foo, CefDeleteOnUIThread> {
/// public:
/// Foo();
/// void DoSomething();
///
/// private:
/// // Allow deletion via scoped_refptr only.
/// friend struct CefDeleteOnThread<TID_UI>;
/// friend class base::RefCountedThreadSafe<Foo, CefDeleteOnUIThread>;
///
/// virtual ~Foo() {}
/// };
///
/// base::scoped_refptr<Foo> foo = new Foo();
/// foo->DoSomething();
/// foo = NULL; /// Deletion of |foo| will occur on the UI thread.
/// </pre>
///
template <CefThreadId thread>
struct CefDeleteOnThread {
template <typename T>
@ -125,7 +128,7 @@ struct CefDeleteOnRendererThread : public CefDeleteOnThread<TID_RENDERER> {};
IMPLEMENT_REFCOUNTING_EX(ClassName, CefDeleteOnIOThread)
///
// Helper class to manage a scoped copy of |argv|.
/// Helper class to manage a scoped copy of |argv|.
///
class CefScopedArgArray {
public: