Doxygen In Files

Author: Ryan Large

Alarm/alarmData.cpp

@@ -27,6 +27,7 @@ SOFTWARE.
 #include <vector>
 #include <iostream>
 
+// Initialize all AlarmData variables upon creation
 AlarmData::AlarmData(
   const std::vector < Alarm::DaysOfWeek>& daysOfWeek,
   const AlarmData::AlarmTime& alarmTime,
@@ -50,6 +51,7 @@ void AlarmData::toggleOnOff() {
   this->on = !this->on;
 }
 
+// Plus or minus hours, for program purpose only. Not display purpose
 void AlarmData::toggleMeridiem() {
   if (this->meridiem == "AM") {
     this->meridiem = "PM";

Alarm/alarmData.h

@@ -37,7 +37,7 @@ class AlarmData {
 
   /**
   * @brief Vibrate struct provides more customization over how the device will react to an alarm being triggered
-  * @param on: Boolean discribing if the alarm should or should not vibrate when triggered
+  * @param on: Boolean describing if the alarm should or should not vibrate when triggered
   * @note The application will automatically set on to false if the device does not support vibration
   * @param intensity: Double to describe how intense the vibration should be
   */
@@ -64,7 +64,7 @@ class AlarmData {
 
   /**
   * @brief AlarmData constructor takes in all necessary data to build a functional alarm to be stored and used in the app
-  * @param daysOfWeek: Vector of integers corrolating to the days of the week an alarm will be triggered on
+  * @param daysOfWeek: Vector of integers correlating to the days of the week an alarm will be triggered on
   * @param alarmTime: @see AlarmTime struct. Gives the hour and minute the alarm should be triggered
   * @param on: Boolean indicating if the alarm is active or not
   * @param meridiem: String indicating if the alarm is for AM or PM. Used only when creating an alarm and when showing the user

Config/files.cpp

@@ -31,6 +31,9 @@ SOFTWARE.
 #include "../Timer/timerData.h"
 #include "../includes/nlohmann/json.hpp"
 
+/**
+* @brief For better readability and development process 
+*/
 using json = nlohmann::json;
 
 Files::Files() {}

Config/files.h

@@ -39,16 +39,31 @@ SOFTWARE.
 #include <shlobj.h>
 #endif
 
-
+/**
+* @brief Files class introduces an abstraction of the filesystem api, and json parsing. This class handles reading and writing to JSON configuration files for the persistent data (Alarms, Timers, Stopwatches) within the application.
+*/
 class Files {
   public:
+  /**
+* @brief Files constructor takes in no parameters and executes no initializing logic
+ */
   Files();
 
   // Timer Methods
+  /**
+  * @brief getTimers takes in no parameters. This method is made to fetch timers stored from a configuration file
+  which is either existing or being created by the application and returns them to the caller of the method or an empty vector
+  * @return A vector of TimerData structures. @see TimerData
+  */
   std::vector < TimerData > getTimers();
   void saveTimers(const std::vector<TimerData>& times);
 
   // Alarm Methods
+  /**
+* @brief getAlarms takes in no parameters. This method is made to fetch alarms from a configuration file
+which is either existing or being created by the application and returns them to the caller of the method or an empty vector
+* @return A vector of AlarmData structures. @see AlarmData
+*/
   std::vector<AlarmData> getAlarms();
 
   protected: