Ucalgary_Baja/BajaUofCWebsite
4
0
Fork 0
mirror of https://github.com/UofCBaja/BajaUofCWebsite.git synced 2025-06-15 13:24:17 -06:00
Code Issues Packages Projects Releases Wiki Activity

added jsdoc comments

Browse Source
This commit is contained in:
darkicewolf50 2024-01-20 13:32:17 -07:00
parent 6147999572
commit 58ce8d75d4
1 changed files with 17 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
src/OurSponsors/OurSponsors.js
View File

@ -5,25 +5,19 @@ import './OurSponsors.css'
import fakeDelay from '../TestingTools/fakeDelay'; import fakeDelay from '../TestingTools/fakeDelay';
import { useNavigate } from 'react-router-dom'; import { useNavigate } from 'react-router-dom';
/* /**
things to do * @param {null} null - requires onthing
*add link to become a sponsor at top, and thank you message * @returns {JSX.Element} JSX - HTML tags and JS functionality
*/ * @description Our Sponsors Page
* @author Brock <darkicewolf50@gmail.com>
* @todo add link to become a sponsor at top, and thank you message
*/
const OurSponsors = () => { const OurSponsors = () => {
/*
OurSponsors Page
REQUIRES:
Nothing
PROMISES:
HTML tags and functionality
Develop in part by: Brock
Contact: darkicewolf50@gmail.com
*/
const [sponsorsDict, setSponsorsDict] = useState(); //variable states for the dictionary of sponsors const [sponsorsDict, setSponsorsDict] = useState(); //variable states for the dictionary of sponsors
useEffect(() => { useEffect(() => { //get sponsors on startup of page not optimized
getSponsors(); //get sponsors on startup of page getSponsors();
}, []); }, []);
const OpenPage = (arg) => { const OpenPage = (arg) => {
@ -32,16 +26,14 @@ const OurSponsors = () => {
console.log(arg); console.log(arg);
}; };
/**
* @param {null} null - requires nothing (link)
* @returns {Object} sponsorsDict - gets a Dictionary of our sponsors from synology drive
* @description Gets the list of sponsors from the synology drive (not implemented), converts the json file into a dictionary
* @author Brock <darkicewolf50@gmail.com>
* @todo add gPRC to backend and front end
*/
const getSponsors = async () => { const getSponsors = async () => {
/*
Gets the list of sponsors from the synology drive (not implemented), converts the json file into a dictionary
REQUIRES:
constant html link to synology drive
PROMISES:
returns Dictionary list of all our sponsors in this format of json file
Develop in part by: Brock
Contact: darkicewolf50@gmail.com
*/
const tempListOfSponsors = { const tempListOfSponsors = {
"Main Tier": { "Main Tier": {
1:{ 1:{