Add documentation for the new functions

bugdea1er · Mar 12, 2024 · 1375095 · 1375095
1 parent 977d0c1
commit 1375095
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/include/tmp/directory b/include/tmp/directory
@@ -45,6 +45,12 @@ public:
     /// @throws std::filesystem::filesystem_error if cannot create a directory
     explicit directory(std::string_view prefix = "");
 
+    /// Creates a unique temporary copy recursively from the given path
+    ///
+    /// @param path   A path to make a temporary copy from
+    /// @param prefix A prefix to be used in the temporary directory path
+    /// @return The new temporary directory
+    /// @throws std::filesystem::filesystem_error if the given path is not a directory
     static directory copy(const std::filesystem::path& path, std::string_view prefix = "");
 
     /// Concatenates this directory path with a given @p source

diff --git a/include/tmp/file b/include/tmp/file
@@ -59,6 +59,12 @@ public:
     /// @throws std::filesystem::filesystem_error if cannot create a file
     static file text(std::string_view prefix = "");
 
+    /// Creates a unique temporary copy from the given path
+    ///
+    /// @param path   A path to make a temporary copy from
+    /// @param prefix A prefix to be used in the temporary directory path
+    /// @return The new temporary file
+    /// @throws std::filesystem::filesystem_error if the given path is not a regular file
     static file copy(const std::filesystem::path& path, std::string_view prefix = "");
 
     /// Streams the contents of this file