doc comment

This commit is contained in:
Tyler Beckman 2024-10-10 21:12:43 -06:00
parent feed5c7077
commit 0bba075976
Signed by: Ty
GPG key ID: 2813440C772555A4

View file

@ -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 <fstream>