Merge pull request #374 from cornell-dti/linear-progress-documentation

Linear Progress documentation
cornell-dti · Oct 28, 2024 · 7bb952b · 7bb952b
2 parents dfe54dd + f35a037
commit 7bb952b
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/frontend/src/components/utils/LinearProgress.tsx b/frontend/src/components/utils/LinearProgress.tsx
@@ -14,6 +14,16 @@ const useStyles = makeStyles((theme: Theme) =>
   })
 );
 
+/**
+ * LinearIndeterminate Component – Displays a linear progress bar.
+ *
+ * @remarks
+ * This component provides a visual indication of an indeterminate loading process.
+ * It utilizes Material-UI's LinearProgress component.
+ *
+ * @return {ReactElement} The rendered LinearIndeterminate component with a centered linear progress bar.
+ */
+
 export default function LinearIndeterminate(): ReactElement {
   const classes = useStyles();
   return (