Skip to content

Commit

Permalink
Tidy up new documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bugdea1er committed Jan 29, 2024
1 parent a05e324 commit da279a6
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions include/tmp/directory.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -28,7 +28,7 @@ namespace tmp {
/// #include <tmp/directory.hpp>
///
/// 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
Expand Down
2 changes: 1 addition & 1 deletion include/tmp/file.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions include/tmp/path.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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=
///
Expand Down

0 comments on commit da279a6

Please sign in to comment.