mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
@ -42,20 +42,20 @@
|
||||
#include "include/cef_base.h"
|
||||
|
||||
///
|
||||
// An object representing a temporary / scratch directory that should be cleaned
|
||||
// up (recursively) when this object goes out of scope. Note that since
|
||||
// deletion occurs during the destructor, no further error handling is possible
|
||||
// if the directory fails to be deleted. As a result, deletion is not
|
||||
// guaranteed by this class.
|
||||
//
|
||||
// Multiple calls to the methods which establish a temporary directory
|
||||
// (CreateUniqueTempDir, CreateUniqueTempDirUnderPath, and Set) must have
|
||||
// intervening calls to Delete or Take, or the calls will fail.
|
||||
/// An object representing a temporary / scratch directory that should be
|
||||
/// cleaned up (recursively) when this object goes out of scope. Note that
|
||||
/// since deletion occurs during the destructor, no further error handling is
|
||||
/// possible if the directory fails to be deleted. As a result, deletion is not
|
||||
/// guaranteed by this class.
|
||||
///
|
||||
/// Multiple calls to the methods which establish a temporary directory
|
||||
/// (CreateUniqueTempDir, CreateUniqueTempDirUnderPath, and Set) must have
|
||||
/// intervening calls to Delete or Take, or the calls will fail.
|
||||
///
|
||||
class CefScopedTempDir {
|
||||
public:
|
||||
///
|
||||
// No directory is owned/created initially.
|
||||
/// No directory is owned/created initially.
|
||||
///
|
||||
CefScopedTempDir();
|
||||
|
||||
@ -63,51 +63,51 @@ class CefScopedTempDir {
|
||||
CefScopedTempDir& operator=(const CefScopedTempDir&) = delete;
|
||||
|
||||
///
|
||||
// Recursively delete path.
|
||||
/// Recursively delete path.
|
||||
///
|
||||
~CefScopedTempDir();
|
||||
|
||||
///
|
||||
// Creates a unique directory in TempPath, and takes ownership of it.
|
||||
// See file_util::CreateNewTemporaryDirectory.
|
||||
/// Creates a unique directory in TempPath, and takes ownership of it.
|
||||
/// See file_util::CreateNewTemporaryDirectory.
|
||||
///
|
||||
[[nodiscard]] bool CreateUniqueTempDir();
|
||||
|
||||
///
|
||||
// Creates a unique directory under a given path, and takes ownership of it.
|
||||
/// Creates a unique directory under a given path, and takes ownership of it.
|
||||
///
|
||||
[[nodiscard]] bool CreateUniqueTempDirUnderPath(const CefString& path);
|
||||
|
||||
///
|
||||
// Takes ownership of directory at |path|, creating it if necessary.
|
||||
// Don't call multiple times unless Take() has been called first.
|
||||
/// Takes ownership of directory at |path|, creating it if necessary.
|
||||
/// Don't call multiple times unless Take() has been called first.
|
||||
///
|
||||
[[nodiscard]] bool Set(const CefString& path);
|
||||
|
||||
///
|
||||
// Deletes the temporary directory wrapped by this object.
|
||||
/// Deletes the temporary directory wrapped by this object.
|
||||
///
|
||||
[[nodiscard]] bool Delete();
|
||||
|
||||
///
|
||||
// Caller takes ownership of the temporary directory so it won't be destroyed
|
||||
// when this object goes out of scope.
|
||||
/// Caller takes ownership of the temporary directory so it won't be destroyed
|
||||
/// when this object goes out of scope.
|
||||
///
|
||||
CefString Take();
|
||||
|
||||
///
|
||||
// Returns the path to the created directory. Call one of the
|
||||
// CreateUniqueTempDir* methods before getting the path.
|
||||
/// Returns the path to the created directory. Call one of the
|
||||
/// CreateUniqueTempDir* methods before getting the path.
|
||||
///
|
||||
const CefString& GetPath() const;
|
||||
|
||||
///
|
||||
// Returns true if path_ is empty.
|
||||
/// Returns true if path_ is empty.
|
||||
///
|
||||
bool IsEmpty() const;
|
||||
|
||||
///
|
||||
// Returns true if path_ is non-empty and exists.
|
||||
/// Returns true if path_ is non-empty and exists.
|
||||
///
|
||||
bool IsValid() const;
|
||||
|
||||
|
Reference in New Issue
Block a user