added more code documentation

mateowatson · May 31, 2021 · 777f8c0 · 777f8c0
1 parent 76a926d
commit 777f8c0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/public/assets/js/app.js b/public/assets/js/app.js
@@ -3,11 +3,13 @@ import $ from "cash-dom";
 import { initTimer } from './timer';
 import { initAjax } from "./ajax";
 
+// if fetch is supported, turn on ajax features
 if (fetch) {
   initTimer();
   initAjax();
 }
 
+// initializes the date picker widget
 function initFlatpickr() {
   flatpickr("#rd", {
     mode: "range",
@@ -16,5 +18,7 @@ function initFlatpickr() {
   });
 }
 
+// initialize the date picker on page load
 initFlatpickr();
+// initialize the date picker after body swaps
 $(window).on('postbodyswap', initFlatpickr);
diff --git a/public/assets/js/timer.js b/public/assets/js/timer.js
@@ -121,6 +121,11 @@ function validate(state) {
   }
 }
 
+/**
+ * Initializes the timer display. It gets the initial elapsed time, starts the
+ * animation loop for the timer, shows the timer running icon, and hides the
+ * "Refresh" link.
+ */
 function initTimerDisplay() {
   // get initial elapsed time if available
   const initialElapsed = elapsedTimeToMs($('[data-timer-elapsed]').data('timer-elapsed'));