Minor commenting changes, removed LED.hpp

RIT-EVT · Feb 24, 2024 · 3e52f8a · 3e52f8a
1 parent b89b1a2
commit 3e52f8a
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 55 deletions.
diff --git a/include/charge_controller/dev/LCDView.hpp b/include/charge_controller/dev/LCDView.hpp
@@ -18,7 +18,7 @@ namespace DEV = EVT::core::DEV;
 namespace CC {
 
 /**
- * Outputs all the values from the ChargeController class to the LCD display
+ * Outputs all the values from the ChargeController & UIModel classes to the LCD display
  * Acts as the view in a Model-View-Controller (MVC) design pattern where
  * UIModel is the model,
  * LCDView is the view, and
@@ -27,7 +27,7 @@ namespace CC {
 class LCDView {
 public:
     /**
-     * Initializer for the LCD Display class.
+     * Initializer for the LCDView class.
      *
      * @param[in] regSelect Register select pin
      * @param[in] reset Reset pin
@@ -36,7 +36,7 @@ class LCDView {
     LCDView(IO::GPIO& reg_select, IO::GPIO& reset, IO::SPI& spi, UIModel& model);
 
     /**
-     * Initializes the LCD driver and displays the splash image.
+     * Initializes the LCD driver
      */
     void init();
 

diff --git a/include/charge_controller/dev/LED.hpp b/include/charge_controller/dev/LED.hpp
diff --git a/include/charge_controller/dev/UIController.hpp b/include/charge_controller/dev/UIController.hpp
@@ -14,21 +14,21 @@ namespace DEV = EVT::core::DEV;
 namespace CC {
 
 /**
- * Outputs all the values from the ChargeController class to the LCD display
- * Acts as the view in a Model-View-Controller (MVC) design pattern where
+ * Outputs all the values from the UIModel and the encoder inputs to the LCD display
+ * Acts as the controller in a Model-View-Controller (MVC) design pattern where
  * UIModel is the model,
  * LCDView is the view, and
  * UIController is the controller.
  */
 class UIController {
 public:
     /**
-     * Constructor for the ControllerUI class
+     * Constructor for the UIController class
      *
      * @param[in] encoder The encoder object
      * @param[in] encoderButton the button on the encoder
-     * @param[in] display the LCDDisplay that the ControllerUI controls
-     * @param[in] model the ControllerModel that stores values from the ControllerUI
+     * @param[in] display the LCDView that this UIController controls
+     * @param[in] model the UIModel that stores values from this UIController
      */
     UIController(EVT::core::DEV::Encoder& encoder, EVT::core::DEV::Button& encoderButton, LCDView& display, UIModel& model);
 

diff --git a/include/charge_controller/dev/UIModel.hpp b/include/charge_controller/dev/UIModel.hpp
@@ -12,8 +12,8 @@
 namespace CC {
 
 /**
- * Outputs all the values from the ChargeController class to the LCD display
- * Acts as the view in a Model-View-Controller (MVC) design pattern where
+ * Stores the values needed to run the UI, modified by UIController, read by LCDView
+ * Acts as the model in a Model-View-Controller (MVC) design pattern where
  * UIModel is the model,
  * LCDView is the view, and
  * UIController is the controller.

diff --git a/src/charge_controller/dev/LCDView.cpp b/src/charge_controller/dev/LCDView.cpp
@@ -7,7 +7,7 @@ void CC::LCDView::init() {
     lcd.clearLCD();
     lcd.setDefaultSections(MAIN_SCREEN_SECTION_TITLES);
 
-    // Splash Screen
+    // Section Headers
     lcd.displaySectionHeaders();
 }