Improved SortController comments and documentation

Author: alesbe

SortController.cpp

@@ -1,40 +1,74 @@
 #include "SortController.h"
 #include "Utils.h"
 
+/**
+ * @brief Sort controller constructor
+ * 
+ * @param windowSize Window size vector (x, y)
+ * @param timeSleep Time to wait between iterations while sorting in miliseconds
+ */
 SortController::SortController(sf::Vector2u windowSize, int timeSleep) {
 	this->winWidth = windowSize.x;
 	this->winHeight = windowSize.y;
 
 	this->timeSleep = timeSleep;
 }
 
-///////////////////////////////
 //
-// Vector control methods
+// ──────────────────────────────────────────────────────────────────────────────────── I ──────────
+//   :::::: V E C T O R   C O N T R O L   M E T H O D S : :  :   :    :     :        :          :
+// ──────────────────────────────────────────────────────────────────────────────────────────────
 //
-///////////////////////////////
 
+/**
+ * @brief Empty the array
+ * 
+ */
 void SortController::clear() {
 	sortElements.clear();
 }
 
+/**
+ * @brief Populate the array with Sorable elements
+ * 
+ * @param numOfElements Number of elements to be included in the array (array size)
+ */
 void SortController::populate(int numOfElements) {
 	for (int n = 0; n < numOfElements; n++) {
 		Sortable sortable(((float)winWidth / numOfElements), ((float)winHeight / numOfElements) * (n+1), n); // Width defined for max space in window, height defined by element value
 		sortElements.push_back(sortable);
 	}
 }
 
+/**
+ * @brief Randomize element positions inside the array
+ * 
+ */
 void SortController::randomize() {
 	auto rd = std::random_device{};
 	auto rng = std::default_random_engine{ rd() };
 	std::shuffle(std::begin(sortElements), std::end(sortElements), rng);
 };
 
+/**
+ * @brief Update time sleep
+ * 
+ * @param t Time to wait between iterations while sorting in miliseconds
+ */
 void SortController::setTimeSleep(int t) {
 	timeSleep = t;
 }
 
+/**
+ * @brief Display sort info on terminal after the algorithm finished
+ * 
+ * @param sortType Number associated to each sort type
+ * @param isSorting true = display only sort type and sorting message, false = display all info
+ * @param numOfComparisons Number of comparisons that the algorithm running made
+ * @param sortTime Time that the algorithm took to sort all elements
+ * 
+ * TODO: Add number of comparisons and time while the algorithm is sorting
+ */
 void SortController::displaySortInfo(int sortType, bool isSorting, int numOfComparisons, int sortTime) {
 	system(CLEAR);
 
@@ -51,12 +85,17 @@ void SortController::displaySortInfo(int sortType, bool isSorting, int numOfComp
 	}
 }
 
-///////////////////////////////
 //
-// Sorting methods
+// ────────────────────────────────────────────────────────────────────── II ──────────
+//   :::::: S O R T I N G   M E T H O D S : :  :   :    :     :        :          :
+// ────────────────────────────────────────────────────────────────────────────────
 //
-///////////////////////////////
 
+/**
+ * @brief Start sort timer, run the algorithm and increment the number of comparisons while the array isn't sorted, and display sort info at the end.
+ * 
+ * @param sortType Number associated to the algorithm
+ */
 void SortController::startSort(int sortType) {
 	isSorting = true;
 	int numOfComparisons = 0;
@@ -90,6 +129,12 @@ void SortController::startSort(int sortType) {
 	checkSortAnim();
 }
 
+/**
+ * @brief Iterate one time through the array to check if is sorted
+ * 
+ * @return true The array is sorted
+ * @return false The array isn't sorted
+ */
 bool SortController::isSorted() {
 	for (int n = 0; n < sortElements.size()-1; n++) {
 		if (sortElements[n].value > sortElements[n+1].value)
@@ -101,7 +146,11 @@ bool SortController::isSorted() {
 	return true;
 };
 
-// This function is only for the "checking animation", the verification is made by isSorted()
+/**
+ * @brief Do a checking animation from the start to the end of the array changing color to green to show that the algorithm finished. (Does not check the array, only do
+ * the color animation)
+ * 
+ */
 void SortController::checkSortAnim() {
 	for (int n = 0; n < sortElements.size(); n++) {
 		sortElements[n].color = sf::Color::Green;