Documentation (#145)

* Basic documentation

Author: jkluge

my-app/src/presenters/PrerequisitePresenter.jsx

@@ -489,7 +489,6 @@ export const PrerequisitePresenter = observer((props) => {
                         courses_taken.push(local[i]?.id)
                     }
                 }
-                //console.log(local);
                 let eligible = generateTree(courses_taken, copy);
                 if (eligible) {
                     root["style"]["backgroundColor"] = "lightgreen";

my-app/src/views/Components/CoursePagePopup.jsx

@@ -2,6 +2,9 @@ import React, { useEffect, useRef, useState } from 'react';
 import RatingComponent from "./RatingComponent.jsx";
 import { model } from "../../model.js";
 
+/**
+ * Handles the popup for a specific course page.
+ */
 
 function CoursePagePopup({
 	favouriteCourses,

my-app/src/views/Components/FavouriteDropdown.jsx

@@ -1,6 +1,9 @@
 import React, { useState } from 'react';
 import { observer } from "mobx-react-lite";
 
+/**
+ * Shows the dropdown menu to see the favourite flagged courses.
+ */
 const FavouritesDropdown = observer((props) => {
     const [copied, setCopied] = useState(false);
 

my-app/src/views/Components/RatingComponent.jsx

@@ -1,6 +1,8 @@
 import React from 'react';
 import StarComponent from "./StarComponent.jsx";
-
+/**
+ * Component that handles reviews in the form of stars. StarComponent is used for the actual stars.
+ */
 const RatingComponent = ({ value = 0, onChange, readOnly = false, className = "" }) => {
     const handleRating = (starIndex, isLeftHalf) => {
         if (readOnly) return;

my-app/src/views/Components/SideBarComponents/ButtonGroupField.jsx

@@ -1,6 +1,12 @@
 import { useEffect, useState } from "react";
 import ToolTip from './ToolTip';
 
+/**
+ * The ButtonGroupField is used as a selector for the period.
+ * Used by the SidebarView.
+ * @param {*} props 
+ * @returns 
+ */
 export default function ButtonGroupField(props) {
 
   const [activeIndex, setActiveIndex] = useState(0);

my-app/src/views/Components/SideBarComponents/CollapsibleCheckboxes.jsx

@@ -2,6 +2,11 @@ import React, { useState, useRef } from "react";
 import FilterEnableCheckbox from "./FilterEnableCheckbox";
 import Tooltip from "./ToolTip";
 
+/**
+ * Used by the SidebarView for filtering things with checkboxes.
+ * @param {*} props 
+ * @returns 
+ */
 const CollapsibleCheckboxes = (props) => {
   const [expanded, setExpanded] = useState([]);
   const [filterEnabled, setFilterEnabled] = useState(props.filterEnable);

my-app/src/views/Components/SideBarComponents/CourseTranscriptList.jsx

@@ -1,5 +1,8 @@
 import { useState, forwardRef } from "react";
-
+/**
+ * Shows a list of taken courses after uploading a transcript of records. 
+ * Used by the SidebarView.
+ */
 const CourseTranscriptList = forwardRef((props,ref) => {
     let local = [];
     if (localStorage.getItem("completedCourses"))

my-app/src/views/Components/SideBarComponents/DropDownField.jsx

@@ -3,6 +3,12 @@ import { useRef, useEffect } from "react";
 import FilterEnableCheckbox from "./FilterEnableCheckbox";
 import Tooltip from "./ToolTip";
 
+/**
+ * Used for selecting the level of a course. 
+ * See SidebarView for more.
+ * @param {*} props 
+ * @returns 
+ */
 export default function DropDownField(props) {
 
 

my-app/src/views/Components/SideBarComponents/FilterEnableCheckbox.jsx

@@ -1,5 +1,9 @@
 import React, { forwardRef } from "react";
 
+/**
+ * A basic checkbox to enable the filters. 
+ * Used in the SidebarView.
+ */
 const FilterEnableCheckbox = forwardRef(({ initialValue, onToggle }, ref) => {
     return (
         <div className='mr-3'>

my-app/src/views/Components/SideBarComponents/MultipleChoiceButtons.jsx

@@ -3,6 +3,11 @@ import { useRef, useEffect } from "react";
 import FilterEnableCheckbox from "./FilterEnableCheckbox";
 import Tooltip from "./ToolTip";
 
+/**
+ * A multiple choice selector used to select the period in the SidebarView.
+ * @param {} props 
+ * @returns 
+ */
 export default function MultipleChoiceButtons(props) {
     const [filterEnabled, setFilterEnabled] = useState(props.filterEnable);
     const [selectedItems, setSelectedItems] = useState(props.initialValues || []);