Add XML documentation

This commit is contained in:
Robert Morrison 2022-06-20 03:45:44 +01:00
parent 69ef560105
commit 2dc16d7c2d
Signed by: robert
GPG Key ID: 73E012EB3F4EC696

View File

@ -99,6 +99,19 @@ class Program
return 0;
}
/// <summary>
/// Returns a list of all the files in the given directory and all subdirectories recursive
/// </summary>
/// <remarks>
/// Currently this function ignores reparse points (symlinks) so as to avoid infinite loops.
/// It is probably a good idea to make the function aware of loops so it can read symlinks.
/// </remarks>
/// <param name="directory">
/// The directory to find files in.
/// <param>
/// <returns>
/// A string list of every file in the provided directory and all subdirectories
/// </returns>
static List<string> GetAllFiles(string directory)
{
List<string> res = new();