From d409643b8eadd934849e2ffb749590e2ea672fb3 Mon Sep 17 00:00:00 2001
From: panky-codes <pankaj.sarathy1992@gmail.com>
Date: Sat, 13 Mar 2021 14:53:37 +0100
Subject: [PATCH] Added some comments for clarity. Ready for review. Tested.

---
 src/displayapp/screens/StopWatch.cpp | 14 +++++++++++++-
 src/displayapp/screens/StopWatch.h   |  4 ++--
 2 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/src/displayapp/screens/StopWatch.cpp b/src/displayapp/screens/StopWatch.cpp
index 9abf9842..b00fc4b8 100644
--- a/src/displayapp/screens/StopWatch.cpp
+++ b/src/displayapp/screens/StopWatch.cpp
@@ -85,7 +85,19 @@ StopWatch::~StopWatch() {
 }
 
 bool StopWatch::Refresh() {
+  // @startuml CHIP8_state
+  // State "INIT" as init
+  // State "RUNNING" as run
+  // State "HALTED" as halt
 
+  // [*] --> init
+  // init -> run : press play
+  // run -> run : press lap
+  // run --> halt : press pause
+  // halt --> run : press play
+  // halt --> init : press stop
+  // @enduml
+  // Copy paste the above plantuml text to visualize the state diagram
   switch (currentState) {
     // Init state when an user first opens the app
     // and when a stop/reset button is pressed
@@ -132,7 +144,7 @@ bool StopWatch::Refresh() {
         if (lapBuffer[0]) {
           lv_label_set_text_fmt(lapTwoText, "#%d   %d:%d:%d", lapNr, lapBuffer[0]->mins, lapBuffer[0]->secs, lapBuffer[0]->msecs);
         }
-        // Reset the bool to avoid setting the text in each cycle
+        // Reset the bool to avoid setting the text in each cycle until there is a change
         lapPressed = false;
       }
 
diff --git a/src/displayapp/screens/StopWatch.h b/src/displayapp/screens/StopWatch.h
index 0d425f72..a5cf5ceb 100644
--- a/src/displayapp/screens/StopWatch.h
+++ b/src/displayapp/screens/StopWatch.h
@@ -21,6 +21,7 @@ namespace Pinetime::Applications::Screens {
     int msecs;
   };
 
+  // A simple buffer to hold the latest two laps
   template <int N> struct LapTextBuffer_t {
     LapTextBuffer_t() : _arr {}, currentSz {}, capacity {N}, head {-1} {
     }
@@ -41,11 +42,11 @@ namespace Pinetime::Applications::Screens {
       head = -1;
     }
 
-    // Optional return type would be much more appropriate here
     TimeSeparated_t* operator[](std::size_t idx) {
       // Sanity check for out-of-bounds
       if (idx >= 0 && idx < capacity) {
         if (idx < currentSz) {
+          // This transformation is to ensure that head is always pointing to index 0.
           const auto transformed_idx = (head - idx) % capacity;
           return (&_arr[transformed_idx]);
         }
@@ -66,7 +67,6 @@ namespace Pinetime::Applications::Screens {
     ~StopWatch() override;
     bool Refresh() override;
     bool OnButtonPushed() override;
-    bool OnTouchEvent(uint16_t x, uint16_t y) override;
     void playPauseBtnEventHandler(lv_event_t event);
     void stopLapBtnEventHandler(lv_event_t event);