From da279a66819f8d4db433a21a6fba868b11e5feca Mon Sep 17 00:00:00 2001 From: bugdea1er Date: Tue, 30 Jan 2024 00:12:39 +0300 Subject: [PATCH] Tidy up new documentation --- include/tmp/directory.hpp | 4 ++-- include/tmp/file.hpp | 2 +- include/tmp/path.hpp | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/include/tmp/directory.hpp b/include/tmp/directory.hpp index 277a41f..1de1e6f 100644 --- a/include/tmp/directory.hpp +++ b/include/tmp/directory.hpp @@ -8,7 +8,7 @@ namespace tmp { /// tmp::directory is a smart handle that owns and manages a temporary directory -/// and disposes of it when this handle goes out of scope +/// and deletes it recursively when this handle goes out of scope /// /// When a tmp::directory object is created, it creates a unique temporary /// directory using the system's default location for temporary files; the path @@ -28,7 +28,7 @@ namespace tmp { /// #include /// /// auto func() { -/// auto tmpdir = tmp::directory("org.example.product); +/// auto tmpdir = tmp::directory("org.example.product"); /// /// // the temporary directory is deleted recursively when the /// // tmp::directory object goes out of scope and is destroyed diff --git a/include/tmp/file.hpp b/include/tmp/file.hpp index 4bddbe8..d40ddd2 100644 --- a/include/tmp/file.hpp +++ b/include/tmp/file.hpp @@ -8,7 +8,7 @@ namespace tmp { /// tmp::file is a smart handle that owns and manages a temporary file and -/// disposes of it when this handle goes out of scope +/// deletes it when this handle goes out of scope /// /// When a tmp::file object is created, it creates a unique temporary file using /// the system's default location for temporary files; the path consists of the diff --git a/include/tmp/path.hpp b/include/tmp/path.hpp index 8c23b44..85604b6 100644 --- a/include/tmp/path.hpp +++ b/include/tmp/path.hpp @@ -6,9 +6,9 @@ namespace tmp { /// tmp::path is a smart handle that owns and manages a temporary path and -/// disposes of it when this handle goes out of scope +/// deletes it recursively when this handle goes out of scope /// -/// The managed path is disposed of when either of the following happens: +/// The managed path is deleted of when either of the following happens: /// - the managing tmp::path object is destroyed /// - the managing tmp::path object is assigned another path via operator= ///