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,70 +45,71 @@ class CefExtensionHandler;
class CefRequestContext;
///
// Object representing an extension. Methods may be called on any thread unless
// otherwise indicated.
/// Object representing an extension. Methods may be called on any thread unless
/// otherwise indicated.
///
/*--cef(source=library)--*/
class CefExtension : public CefBaseRefCounted {
public:
///
// Returns the unique extension identifier. This is calculated based on the
// extension public key, if available, or on the extension path. See
// https://developer.chrome.com/extensions/manifest/key for details.
/// Returns the unique extension identifier. This is calculated based on the
/// extension public key, if available, or on the extension path. See
/// https://developer.chrome.com/extensions/manifest/key for details.
///
/*--cef()--*/
virtual CefString GetIdentifier() = 0;
///
// Returns the absolute path to the extension directory on disk. This value
// will be prefixed with PK_DIR_RESOURCES if a relative path was passed to
// CefRequestContext::LoadExtension.
/// Returns the absolute path to the extension directory on disk. This value
/// will be prefixed with PK_DIR_RESOURCES if a relative path was passed to
/// CefRequestContext::LoadExtension.
///
/*--cef()--*/
virtual CefString GetPath() = 0;
///
// Returns the extension manifest contents as a CefDictionaryValue object. See
// https://developer.chrome.com/extensions/manifest for details.
/// Returns the extension manifest contents as a CefDictionaryValue object.
/// See https://developer.chrome.com/extensions/manifest for details.
///
/*--cef()--*/
virtual CefRefPtr<CefDictionaryValue> GetManifest() = 0;
///
// Returns true if this object is the same extension as |that| object.
// Extensions are considered the same if identifier, path and loader context
// match.
/// Returns true if this object is the same extension as |that| object.
/// Extensions are considered the same if identifier, path and loader context
/// match.
///
/*--cef()--*/
virtual bool IsSame(CefRefPtr<CefExtension> that) = 0;
///
// Returns the handler for this extension. Will return NULL for internal
// extensions or if no handler was passed to CefRequestContext::LoadExtension.
/// Returns the handler for this extension. Will return NULL for internal
/// extensions or if no handler was passed to
/// CefRequestContext::LoadExtension.
///
/*--cef()--*/
virtual CefRefPtr<CefExtensionHandler> GetHandler() = 0;
///
// Returns the request context that loaded this extension. Will return NULL
// for internal extensions or if the extension has been unloaded. See the
// CefRequestContext::LoadExtension documentation for more information about
// loader contexts. Must be called on the browser process UI thread.
/// Returns the request context that loaded this extension. Will return NULL
/// for internal extensions or if the extension has been unloaded. See the
/// CefRequestContext::LoadExtension documentation for more information about
/// loader contexts. Must be called on the browser process UI thread.
///
/*--cef()--*/
virtual CefRefPtr<CefRequestContext> GetLoaderContext() = 0;
///
// Returns true if this extension is currently loaded. Must be called on the
// browser process UI thread.
/// Returns true if this extension is currently loaded. Must be called on the
/// browser process UI thread.
///
/*--cef()--*/
virtual bool IsLoaded() = 0;
///
// Unload this extension if it is not an internal extension and is currently
// loaded. Will result in a call to CefExtensionHandler::OnExtensionUnloaded
// on success.
/// Unload this extension if it is not an internal extension and is currently
/// loaded. Will result in a call to CefExtensionHandler::OnExtensionUnloaded
/// on success.
///
/*--cef()--*/
virtual void Unload() = 0;