From e9d4793b1e98944dad910b3952c117bb2d3369de Mon Sep 17 00:00:00 2001
From: Rachel Powers <508861+Ryex@users.noreply.github.com>
Date: Tue, 25 Oct 2022 20:18:14 -0700
Subject: minor clean up and add some docs

Signed-off-by: Rachel Powers <508861+Ryex@users.noreply.github.com>
---
 launcher/FileSystem.cpp | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'launcher/FileSystem.cpp')

diff --git a/launcher/FileSystem.cpp b/launcher/FileSystem.cpp
index 4285fa87..8fe441b3 100644
--- a/launcher/FileSystem.cpp
+++ b/launcher/FileSystem.cpp
@@ -163,6 +163,10 @@ bool ensureFolderPathExists(QString foldernamepath)
     return success;
 }
 
+/// @brief Copy file at src to dest, ensures the full filepath exsists
+/// @param src srouce file path
+/// @param dst destination file path
+/// @return boolean: was there an error during the filecopy?
 bool copyFile(QString &src, QString &dst) {
     using copy_opts = fs::copy_options;
 
@@ -185,6 +189,9 @@ bool copyFile(QString &src, QString &dst) {
 
 }
 
+/// @brief Copies a directory and it's contents from src to dest
+/// @param offset subdirectory form src to copy to dest
+/// @return if there was an error during the filecopy
 bool copy::operator()(const QString& offset)
 {
     using copy_opts = fs::copy_options;
-- 
cgit