From 2dc16d7c2d10afe76a7721ba93286eb8926c40b7 Mon Sep 17 00:00:00 2001
From: Robert Morrison <sherlock5512@gmail.com>
Date: Mon, 20 Jun 2022 03:45:44 +0100
Subject: [PATCH] Add XML documentation

---
 Program.cs | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/Program.cs b/Program.cs
index 982a4f0..a1b6a09 100644
--- a/Program.cs
+++ b/Program.cs
@@ -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();