docs: add missing documentation

calblueprint · Mar 16, 2024 · 5d8294f · 5d8294f
1 parent f4bfd34
commit 5d8294f
Show file tree

Hide file tree

Showing 12 changed files with 22 additions and 109 deletions.
diff --git a/src/app/collectionsPage/page.tsx b/src/app/collectionsPage/page.tsx
diff --git a/src/app/dummyPage/page.tsx b/src/app/dummyPage/page.tsx
diff --git a/src/app/featuredToursPage/[tourId]/[displayId]/page.tsx b/src/app/featuredToursPage/[tourId]/[displayId]/page.tsx
@@ -11,12 +11,12 @@ import { fetchImagesForDisplay } from '../../../../supabase/media/queries';
 import Carousel from '../../../../components/userComponents/ImageScroller/ImageScroller';
 
 /**
- * The page that displays a tour stop.
+ * Displays a stop page for the current tour
  * @param params -
  * @param params.params -
- * @param params.params.tourId - The tour ID.
- * @param params.params.displayId - The display ID.
- * @returns The tour stop page.
+ * @param params.params.tourId - The tour ID
+ * @param params.params.displayId - The display ID
+ * @returns The tour stop page
  */
 export default function TourStopPage({
   params,

diff --git a/src/app/featuredToursPage/[tourId]/page.tsx b/src/app/featuredToursPage/[tourId]/page.tsx
@@ -10,11 +10,11 @@ import { fetchTourDisplays } from '../../../supabase/tour_displays/queries';
 import { fetchAllDisplays } from '../../../supabase/displays/queries';
 
 /**
- * The page that displays the start of a tour.
+ * Displays the start page for a tour
  * @param params -
  * @param params.params -
- * @param params.params.tourId - The tour ID.
- * @returns The tour start page.
+ * @param params.params.tourId - The tour ID
+ * @returns The tour start page
  */
 export default function TourStartPage({
   params,

diff --git a/src/app/featuredToursPage/[tourId]/tourEndPage/page.tsx b/src/app/featuredToursPage/[tourId]/tourEndPage/page.tsx
@@ -10,11 +10,11 @@ import { fetchTour } from '../../../../supabase/tours/queries';
 import { fetchTourMedia } from '../../../../supabase/tour_media/queries';
 
 /**
- * The page that displays the end of a tour.
+ * Displays end page for a tour
  * @param params -
  * @param params.params -
- * @param params.params.tourId - The tour ID.
- * @returns The tour end page.
+ * @param params.params.tourId - The tour ID
+ * @returns The tour end page
  */
 export default function TourEndPage({
   params,

diff --git a/src/app/featuredToursPage/page.tsx b/src/app/featuredToursPage/page.tsx
@@ -8,8 +8,8 @@ import NavBar from '../../components/userComponents/navBar/navBar';
 import { TourRow } from '../../types/types';
 
 /**
- * The page that displays all the featured tours.
- * @returns The featured tours page.
+ * Displays a list of all featured tours
+ * @returns The featured tours page
  */
 export default function FeaturedToursPage() {
   const [tours, setTours] = useState<TourRow[]>([]);

diff --git a/src/app/hoursAdmissionPage/page.tsx b/src/app/hoursAdmissionPage/page.tsx
@@ -4,6 +4,9 @@ import React from 'react';
 import Link from 'next/link';
 import NavBar from '../../components/userComponents/navBar/navBar';
 
+/**
+ * @returns The hours and admission page
+ */
 function App() {
   return (
     <div style={{ backgroundColor: '#ebf0e4', height: '100vh' }}>

diff --git a/src/app/newsFeedPage/page.tsx b/src/app/newsFeedPage/page.tsx
@@ -3,6 +3,9 @@
 import React from 'react';
 import NavBar from '../../components/userComponents/navBar/navBar';
 
+/**
+ * @returns The news feed page
+ */
 function App() {
   return (
     <div style={{ backgroundColor: '#ebf0e4', height: '100vh' }}>

diff --git a/src/app/qrCodeScanner/page.tsx b/src/app/qrCodeScanner/page.tsx
diff --git a/src/app/qrCodeTourPage/page.tsx b/src/app/qrCodeTourPage/page.tsx
diff --git a/src/components/userComponents/navBar/navBar.tsx b/src/components/userComponents/navBar/navBar.tsx
@@ -2,21 +2,20 @@ import React, { useState } from 'react';
 import Link from 'next/link';
 
 /**
- *
+ * @returns The navigation bar for the web app
  */
 function NavBar() {
   const [showMenu, setShowMenu] = useState(false);
 
   /**
-   *
+   * Toggles the side menu
    */
   function handleClick() {
     setShowMenu(!showMenu);
   }
 
   /**
-   *
-   * @param event
+   * @param event - Close the side menu when the escape key is pressed
    */
   function handleKeyDown(event: React.KeyboardEvent<HTMLButtonElement>) {
     if (event.key === 'Escape') {

diff --git a/src/supabase/tour_displays/queries.tsx b/src/supabase/tour_displays/queries.tsx
@@ -1,7 +1,7 @@
 'use client';
 
 import supabase from '../client';
-import { TourDisplaysRow, DisplayRow, TourRow } from '../../types/types';
+import { TourDisplaysRow, DisplayRow } from '../../types/types';
 import { fetchDisplaysfromIds } from '../displays/queries';
 
 /**
@@ -33,7 +33,6 @@ export async function fetchMatchingTourDisplayIdsfromSpotlight(tourId: string) {
     );
   }
   const displayIds = data.map(item => item.display_id);
-  console.log('hello?');
   return displayIds;
 }