Additional documentation

GavinLynch04 · Dec 8, 2023 · 8ebbf2c · 8ebbf2c
1 parent ef612a3
commit 8ebbf2c
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 79 deletions.
diff --git a/packages/backend/receipts.zip b/packages/backend/receipts.zip
diff --git a/packages/frontend/src/AddUsers.js b/packages/frontend/src/AddUsers.js
@@ -6,6 +6,7 @@ function InputField({ onInputChange }) {
 
     const handleSubmit = (e) => {
         e.preventDefault();
+        // Data validation to ensure the field is not empty
         if (inputValue !== "") {
             onInputChange(inputValue);
             setInputValue('');

diff --git a/packages/frontend/src/App.js b/packages/frontend/src/App.js
@@ -4,11 +4,11 @@ import HomePage from './HomePage'
 import LoginSignup from "./LoginSignup";
 import ImageUpload from './ImageUpload';
 import ImageCapture from './ImageCapture';
-import History from './History.js';
 import {BrowserRouter as Router, Routes, Route, Navigate } from 'react-router-dom';
 
 function CreateTable() {
 
+    // Upload page
     const Upload = () => {
         return (
             <div>
@@ -18,6 +18,7 @@ function CreateTable() {
         );
     };
 
+    // Image capture page
     const ICAP = () => {
         return (
             <div>
@@ -27,15 +28,6 @@ function CreateTable() {
         )
     }
 
-    const HistoryPage = () => {
-        return (
-            <div>
-                <Header/>
-                <History />
-            </div>
-        )
-    }
-
     const PrivateRoute = ({ element }) => {
         const token = localStorage.getItem('token');
         return token ? element : <Navigate to="/" />;
@@ -48,7 +40,6 @@ function CreateTable() {
                     path="/imageUpload"
                     element={<PrivateRoute element={<Upload />} />}
                 />
-                <Route path="/history" element={<HistoryPage />} />
                 <Route path="/imageCapture" element={<PrivateRoute element={<ICAP />}/>} />
                 <Route path="/" element={<LoginSignup />} />
                 <Route

diff --git a/packages/frontend/src/Header.js b/packages/frontend/src/Header.js
@@ -13,6 +13,7 @@ function Header() {
         );
     };
 
+    // Buttons for the navigation bar at the top of the screen
     return (
         <header>
             <h3>QuickSplit</h3>

diff --git a/packages/frontend/src/History.js b/packages/frontend/src/History.js
diff --git a/packages/frontend/src/PopUp.js b/packages/frontend/src/PopUp.js
@@ -48,6 +48,7 @@ const PopupButton = (props) => {
                     },
                 }}
 
+                // Button to close the popup
             >
                 <div>
                     {popupData.map((item, index) => (

diff --git a/packages/frontend/src/Table.js b/packages/frontend/src/Table.js
@@ -71,15 +71,17 @@ const Table = (props) => {
     }
 
     const splitEvenly = () => {
-        // When a button is clicked this updates the clicked attribute in the 2d array
+        // When the split evenly button is clicked this updates the clicked attribute in the 2d array,
+        // setting all values to true (selected)
         const newButtonStates = props.jsonData.map(() =>
             buttonLabels.map(() => ({ clicked: true }))
         );
         setButtonStates(newButtonStates);
     };
 
     const clear = () => {
-        // When a button is clicked this updates the clicked attribute in the 2d array
+        // When the clear button is clicked this updates the clicked attribute in the 2d array and sets all
+        // values to false (not selected)
         const newButtonStates = props.jsonData.map(() =>
             buttonLabels.map(() => ({ clicked: false }))
         );