Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JSDoc Comments to RegionMap.jsx #198

Closed
wants to merge 2 commits into from
Closed

Add JSDoc Comments to RegionMap.jsx #198

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e072e13
feat: Updated frontend/src/components/RegionMap.js
sweep-ai[bot] Jan 1, 2024
683c278
Merge main into sweep/add-jsdoc-regionmap
sweep-ai[bot] Jan 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions frontend/src/components/RegionMap.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
/**
* This file contains the MapComponent which initializes and displays
* a map using MapLibre for the currently selected region.
*
* The functions within help manage map interactions such as selecting a region, fetching
* and displaying region data, and handling visual updates.
*/
import React, { useEffect, useRef, useState } from 'react';
import maplibregl from 'maplibre-gl';
import Tooltip from '@mui/material/Tooltip';
Expand All @@ -15,6 +22,12 @@ import {
*
* @return {JSX.Element} A div that contains either an error message or the map container.
*/
/**
* Initializes and displays a map using MapLibre for the currently selected region.
* It does not take any parameters and does not return any value.
*
* @function
*/
function MapComponent() {
const mapContainer = useRef(null);
const map = useRef(null);
Expand Down
Loading