From 0bba0759769aa06703b8afdbb338457d569d8bd5109091fc94714d73dcf04459 Mon Sep 17 00:00:00 2001 From: Tyler Beckman Date: Thu, 10 Oct 2024 21:12:43 -0600 Subject: [PATCH] doc comment --- OutputProcessor.cpp | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/OutputProcessor.cpp b/OutputProcessor.cpp index 2f3e440..1952b87 100644 --- a/OutputProcessor.cpp +++ b/OutputProcessor.cpp @@ -1,3 +1,22 @@ +/** + * @author Tyler Beckman (tyler_beckman@mines.edu) + * @brief A3 - A program to parse a text input and analyze it for statistics based on + * word and letter frequency, and then output them to a user-specified file. It + * assumes text is only alphabetical + spaces + the punctuation contained within + * main.cpp. In addition, the list of word counts is sorted using a recursive + * MSD radix sort before being outputted into the specified file. + * @version 1 + * @date 2024-10-10 + * + * Resources used: + * For the general program (not sorting), I utilized all autocomplete and + * cppreference to find the detailed reference of functions I needed to use. For + * implementing radix sort I primarily used + * https://en.wikipedia.org/wiki/Radix_sort#Most_significant_digit,_forward_recursive + * and a lot of trial and error. The sorting part is also VERY commented to make + * sure I knew exactly what I was doing at each point and why I was doing it. + */ + #include "OutputProcessor.h" #include