documentation done

client/src/components/AppBarMenuButton.js

@@ -4,7 +4,9 @@ import MenuItem from "@mui/material/MenuItem";
 import IconButton from "@mui/material/IconButton";
 import MenuIcon from "@mui/icons-material/Menu";
 import { useNavigate } from "react-router-dom";
-
+/**
+ * The App bar menu button function creates the app bar nav button and incorporates the other pages into the nav bar. 
+     */
 export default function AppBarMenuButton() {
   const [anchorEl, setAnchorEl] = React.useState(null);
   const navigate = useNavigate();

client/src/components/GoogleTranslateButton.js

@@ -1,5 +1,7 @@
 import { useEffect } from "react";
-
+/**
+ * The GoogleTranslateButton function creates the button at the top of each page that can translate the page that it is on.
+     */
 const GoogleTranslateButton = () => {
   const googleTranslateElementInit = () => {
     new window.google.translate.TranslateElement(

client/src/components/PendingRestockTable.js

@@ -22,7 +22,7 @@ const config = {
   }
 };
 
-/*
+/** 
 * UI for a material react table populated with restock orders that have not been marked as arrived in the database
 */
 export default class PendingRestockTable extends React.Component {

client/src/components/ReactWeatherComponent.js

@@ -1,5 +1,7 @@
 import ReactWeather, { useVisualCrossing } from 'react-open-weather';
-
+/**
+     * The react weather component function incorporates the weather api into our project that can be used on necessary pages.
+     */
 const ReactWeatherComponent = () => {
     /*
     const { data, isLoading, errorMessage } = useWeatherBit({

client/src/components/RestockReportTable.js

@@ -23,7 +23,9 @@ const config = {
     "Access-Control-Allow-Methods": "GET,PUT,POST,DELETE,PATCH,OPTIONS"
   }
 };
-
+/**
+     * The Restock Report Table function builds the table used in the restock report and queries the database for the report.
+     */
 export default class RestockReportTable extends React.Component {
   constructor(props) {
     super(props);

client/src/components/SalesReportTable.js

@@ -30,7 +30,7 @@ const config = {
     }
 };
 /** 
- * SalesReportTable class sets up the table of the sales report page. 
+ * @class SalesReportTable class sets up the table of the sales report page. 
  * This class also queries the database with the values from the date time pickers on the web page.
  * It also displays the data.
  */

client/src/components/SignIn.jsx

@@ -2,7 +2,9 @@ import React, { useEffect } from 'react';
 import { GoogleButton } from 'react-google-button';
 import { UserAuth } from '../login/AuthContext';
 import { useNavigate } from 'react-router-dom';
-
+/**
+     * The sign in function creates the sign in functionalities and manages them
+     */
 const SignIn = () => {
   const { googleSignIn, user } = UserAuth();
   const navigate = useNavigate();

client/src/pages/ErrorPage.js

@@ -1,6 +1,8 @@
 import { useRouteError } from "react-router-dom";
 import React from 'react';
-
+/**
+     * The Error Page function builds the error page that shows up when there is an issue with the javascript
+     */
 export default function ErrorPage() {
   const error = useRouteError();
   console.error(error);

client/src/pages/LoginPage.js

@@ -1,6 +1,9 @@
 import React from 'react';
 import SignIn from '../components/SignIn';
-
+/**
+     * Login Page function that sets up the login page and incorporates the sign in component
+     *
+     */
 export default function LoginPage() {
   return (
 

client/src/pages/RestockReportPage.js

@@ -18,6 +18,9 @@ const Item = styled(Paper)(({ theme }) => ({
 }));
 
 // The grid max xs = 12
+/**
+     * Function that builds the restock report page with grids and incorporates the table, app bar
+     */
 function RestockReportPage() {
   return (
     <div className="RestockReportPage">

client/src/pages/SalesReportPage.js

@@ -40,11 +40,8 @@ const cfa_theme = createTheme({
 });
 /**
  * 
- * Sales Report Page function used to build the webpage 
- * Has setStart, setEnd, and setSubmit vars to help store values from the date time
- * selection box 
- * 
- * 
+ * Sales Report Page function used to build the sales report page that holds the sales report table 
+ * and the date time pickers used to query for that table.
  */
 export default function SalesReportPage(){
   const [start, setStart] = useState('');

client/src/pages/TestTranslatePage.js

@@ -1,5 +1,7 @@
 import { useEffect } from "react";
-
+/**
+     * Sets up the google translate component for our project.
+     */
 const TestTranslatePage = () => {
   const googleTranslateElementInit = () => {
     new window.google.translate.TranslateElement(