1. Documentation

Author: Rayffer

TextSearchEngine.DTO/FileRepresentation.cs

@@ -1,8 +1,17 @@
 namespace TextSearchEngine.DTO
 {
+    /// <summary>
+    /// An in-memory representation of a file that holds both the file's filename and contents
+    /// </summary>
     public class FileRepresentation
     {
+        /// <summary>
+        /// The file's filename
+        /// </summary>
         public string FileName { get; set; }
+        /// <summary>
+        /// An in-memory representation of the file's content
+        /// </summary>
         public string Contents { get; set; }
     }
 }

TextSearchEngine.Interfaces/IConsoleProvider.cs

@@ -1,13 +1,33 @@
 namespace TextSearchEngine.Interfaces
 {
+    /// <summary>
+    /// An interface to allow outputting and inputting information into the application
+    /// </summary>
     public interface IConsoleProvider
     {
+        /// <summary>
+        /// Writes a line to the device and performs a carry return after writting it
+        /// </summary>
+        /// <param name="textToWrite">The text to write</param>
         void WriteLine(string textToWrite);
 
+
+        /// <summary>
+        /// Writes a line to the device 
+        /// </summary>
+        /// <param name="textToWrite">The text to write</param>
         void Write(string textToWrite);
 
+        /// <summary>
+        /// Reads the next keystroke performed on the input device
+        /// </summary>
+        /// <returns>A string representation of the stroken device's key</returns>
         string ReadKey();
 
+        /// <summary>
+        /// Reads the next line performed on the input device until a carry return is performed
+        /// </summary>
+        /// <returns>The line of text inputted from the device</returns>
         string ReadLine();
     }
 }

TextSearchEngine.Interfaces/IFileProvider.cs

@@ -5,6 +5,11 @@ namespace TextSearchEngine.Interfaces
 {
     public interface IFileProvider
     {
+        /// <summary>
+        /// Returns a <seealso cref="IEnumerable{T}"/> of <seealso cref="FileRepresentation"/> of all the files inside a directory
+        /// </summary>
+        /// <param name="directory">The directory in which to enumerate the files</param>
+        /// <returns><seealso cref="IEnumerable{T}"/> of <seealso cref="FileRepresentation"/></returns>
         IEnumerable<FileRepresentation> GetFileRepresentationsFromDirectory(string directory);
     }
 }

TextSearchEngine.Interfaces/IFileTextSearcher.cs

@@ -2,6 +2,12 @@
 {
     public interface IFileTextSearcher
     {
+        /// <summary>
+        /// Counts the number of <paramref name="searchTerm"/> occurrences inside <paramref name="fileString"/>
+        /// </summary>
+        /// <param name="fileString">The file or file contents in which to perform the searchs</param>
+        /// <param name="searchTerm">The search term</param>
+        /// <returns>The amount of occurrences that <paramref name="searchTerm"/> occurs in the file/returns>
         int SearchOccurrences(string fileString, string searchTerm);
     }
 }

TextSearchEngine.Library/ConsoleProviders/SystemConsoleProvider.cs

@@ -7,23 +7,42 @@
 
 namespace TextSearchEngine.Library.ConsoleProviders
 {
+    /// <summary>
+    /// A class to use the system console to output and input information from the application wherever it is needed
+    /// </summary>
     public class SystemConsoleProvider : IConsoleProvider
     {
+        /// <summary>
+        /// Reads the next key pressed by the user, blocks execution until a key is pressed
+        /// </summary>
+        /// <returns>The string representation of the pressed key</returns>
         public string ReadKey()
         {
             return Console.ReadKey().KeyChar.ToString();
         }
 
+        /// <summary>
+        /// Reads a line of text from the console, blocks execution until the enter key is pressed.
+        /// </summary>
+        /// <returns>The line of text written until the return key</returns>
         public string ReadLine()
         {
             return Console.ReadLine();
         }
 
+        /// <summary>
+        /// Writes the <paramref name="textToWrite"/> string to the console
+        /// </summary>
+        /// <param name="textToWrite">The text to write</param>
         public void Write(string textToWrite)
         {
             Console.Write(textToWrite);
         }
 
+        /// <summary>
+        /// Writes the <paramref name="textToWrite"/> string to the console and performs a carry return and line feed
+        /// </summary>
+        /// <param name="textToWrite">The text to write</param>
         public void WriteLine(string textToWrite)
         {
             Console.WriteLine(textToWrite);

TextSearchEngine.Library/FileProviders/SystemFileProvider.cs

@@ -6,8 +6,17 @@
 
 namespace TextSearchEngine.Library.FileProviders
 {
+    /// <summary>
+    /// Retrieves the file/s in a directory through the native file system
+    /// </summary>
     public class SystemFileProvider : IFileProvider
     {
+        /// <summary>
+        /// Explores a directory, compiles a list of all the files inside it, reads them 
+        /// and creates a list of <seealso cref="FileRepresentation"/> from its contents and filename
+        /// </summary>
+        /// <param name="directory">The directory in which to search for files</param>
+        /// <returns>A list of <seealso cref="FileRepresentation"/> with the associated contents and filename</returns>
         public IEnumerable<FileRepresentation> GetFileRepresentationsFromDirectory(string directory)
         {
             var files = System.IO.Directory.GetFiles(directory);

TextSearchEngine.Library/FileSearchEngines/FileSearchEngine.cs

@@ -4,13 +4,19 @@
 
 namespace TextSearchEngine.Library.FileSearchEngines
 {
+    /// <summary>
+    /// An engine that given a directory, allows to perform any amount of text searchs within the text of all the files inside it
+    /// </summary>
     public class FileSearchEngine : IFileSearchEngine
     {
         private readonly IFileProvider fileProvider;
         private readonly IFileTextSearcher fileTextSearcher;
         private readonly IConsoleProvider consoleProvider;
 
-        private string exitString = "$end";
+        /// <summary>
+        /// A command that signals the engine to stop and end its execution
+        /// </summary>
+        private readonly string exitString = "$end";
 
         [InjectionConstructor]
         public FileSearchEngine(IFileProvider fileProvider,
@@ -22,6 +28,11 @@ public FileSearchEngine(IFileProvider fileProvider,
             this.consoleProvider = consoleProvider;
         }
 
+        /// <summary>
+        /// Starts the search engine in the directory specified by the <paramref name="searchDirectory"/> parameter and waits for user input.
+        /// To stop the engine, type $end
+        /// </summary>
+        /// <param name="searchDirectory">The directory in which to perform the searchs</param>
         public void StartEngine(string searchDirectory)
         {
             var fileRepresentations = fileProvider.GetFileRepresentationsFromDirectory(searchDirectory);

TextSearchEngine.Library/FileTextSearchers/RegexFileTextSearcher.cs

@@ -3,8 +3,17 @@
 
 namespace TextSearchEngine.Library.FileTextSearchers
 {
+    /// <summary>
+    /// A class that uses Regex to search a given text in a string
+    /// </summary>
     public class RegexFileTextSearcher : IFileTextSearcher
     {
+        /// <summary>
+        /// Counts the number of occurrences that the <paramref name="searchTerm"/> occurs in the content of the provided <paramref name="fileString"/>
+        /// </summary>
+        /// <param name="fileString">The string in which to search for the <paramref name="searchTerm"/> </param>
+        /// <param name="searchTerm">The search term</param>
+        /// <returns>The amount of occurrences that <paramref name="searchTerm"/> occurs in the file
         public int SearchOccurrences(string fileString, string searchTerm)
         {
             return Regex.Matches(fileString, searchTerm).Count;

TextSearchEngine.Library/Unity/ConfigureUnity.cs

@@ -12,8 +12,16 @@
 
 namespace TextSearchEngine.Library.Unity
 {
+    /// <summary>
+    /// This class intends to expose a method which fills the container provided as a parameter with all of the dependencies
+    /// that this class declares
+    /// </summary>
     public static class ConfigureUnity
     {
+        /// <summary>
+        /// Registers all the dependencies this method declares in the container passed as the parameter of the method
+        /// </summary>
+        /// <param name="unityContainer">The container in which to declare dependencies</param>
         public static void ConfigureContainer(IUnityContainer unityContainer)
         {
             unityContainer.RegisterType<IConsoleProvider, SystemConsoleProvider>();