Skip to content

Commit

Permalink
add documentation headers for ALL COMPLETED FILES
Browse files Browse the repository at this point in the history
  • Loading branch information
abhi-arya1 committed Jan 3, 2024
1 parent 2d17639 commit 89b8785
Show file tree
Hide file tree
Showing 14 changed files with 81 additions and 5 deletions.
6 changes: 6 additions & 0 deletions src/__tests__/App.test.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @electron-react-boilerplate
* @type App Test
* @fileoverview Render-checking for the LMCC App
*/

import '@testing-library/jest-dom';
import { render } from '@testing-library/react';
import App from '../renderer/App';
Expand Down
6 changes: 6 additions & 0 deletions src/components/HMD_LINK/conn_strength.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @abhi-arya1
* @function ConnectionStrength
* @fileoverview https://docs.google.com/document/d/12t25fQjffmaiEypirbH_cjmmGfv19-wLZXoTAJ37Qf0/edit?usp=sharing
*/

/* eslint-disable no-nested-ternary */
import { SignalHigh, SignalLow, SignalMedium } from 'lucide-react';

Expand Down
6 changes: 6 additions & 0 deletions src/components/HMD_LINK/eva_live_view.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @abhi-arya1
* @function EVALiveView
* @fileoverview https://docs.google.com/document/d/1wiDTSK4uR1we2z8LcobuU8MG8j1gtWkV8PsYyITrCy4/
*/

/* eslint-disable react/require-default-props */
import ReactPlayer from 'react-player';

Expand Down
6 changes: 6 additions & 0 deletions src/components/HMD_LINK/eva_telemetry.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @abhi-arya1
* @function EvaTelemetry
* @fileoverview https://docs.google.com/document/d/1Xy8z90BzejGYqI_AKgyO51-lsJwjt9BTSWW9DCOqp5Q/
*/

/* eslint-disable prefer-const */
/* eslint-disable react/require-default-props */

Expand Down
6 changes: 6 additions & 0 deletions src/components/HMD_LINK/panic_button.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @abhi-arya1
* @function PanicButton
* @fileoverview Coming once all "TODO:" are complete
*/

import { Button } from '@mui/material';
import { AlertTriangle } from 'lucide-react';

Expand Down
6 changes: 6 additions & 0 deletions src/components/NAVIGATION/minimap.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @abhi-arya1
* @function MiniMap
* @fileoverview Coming once all "TODO:" are complete
*/

function MiniMap() {
return <div>TODO: MiniMap</div>;
}
Expand Down
6 changes: 6 additions & 0 deletions src/components/PAGES/home_page.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @abhi-arya1
* @function HomePage
* @fileoverview https://docs.google.com/document/d/1DABLaMeVG6YfqvkmPyuQxoyOtKfFTCykDSIMbTua3FQ/
*/

import { useNavigate } from 'react-router-dom';
import { Button } from '@mui/material/';
import Timers from '../UI_AND_UX/timing';
Expand Down
7 changes: 7 additions & 0 deletions src/components/PAGES/telemetry_page.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @abhi-arya1
* @function TelemetryPage
* @fileoverview Coming once all "TODO:" are complete
*/

import { Button } from '@mui/material';
import { useNavigate } from 'react-router-dom';
import Timers from '../UI_AND_UX/timing';
Expand All @@ -15,6 +21,7 @@ function TelemetryPage() {
>
Back to Home
</Button>
{/* TODO: Finish this file */}
</div>
);
}
Expand Down
7 changes: 7 additions & 0 deletions src/components/ROVER/rover_live_view.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
/**
* @author @abhi-arya1
* @function EVALiveView
* @fileoverview While this document isn't specifically for rover live view, it is essentially the same with different Border Radii:
* https://docs.google.com/document/d/1wiDTSK4uR1we2z8LcobuU8MG8j1gtWkV8PsYyITrCy4/
*/

/* eslint-disable react/require-default-props */
import ReactPlayer from 'react-player';

Expand Down
6 changes: 6 additions & 0 deletions src/components/UI_AND_UX/github_button.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @abhi-arya1
* @function GitHubButton
* @fileoverview This is simply a GitHub Repository Access Button in the bottom-right of the App.
*/

import { GitHub } from '@mui/icons-material';
import { IconButton } from '@mui/material';

Expand Down
6 changes: 6 additions & 0 deletions src/components/UI_AND_UX/timing.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @abhi-arya1
* @function Timers
* @fileoverview https://docs.google.com/document/d/1hmx74L0iU5ikTFpniqynhU_xts1HKvM1jPmr64Lin-o/
*/

/* eslint-disable react/destructuring-assignment */
/* eslint-disable max-classes-per-file */
import React from 'react';
Expand Down
5 changes: 0 additions & 5 deletions src/main/startup.py

This file was deleted.

6 changes: 6 additions & 0 deletions src/providers/stopwatch_provider.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* @author @abhi-arya1
* @function StopwatchProvider
* @fileoverview https://docs.google.com/document/d/1Zqneli7AeubiU10YHZqsq5emFCdpV_srpxIv92XRRfg/
*/

/* eslint-disable react-hooks/exhaustive-deps */
/* eslint-disable react/jsx-no-constructed-context-values */
/* eslint-disable react/function-component-definition */
Expand Down
7 changes: 7 additions & 0 deletions src/renderer/App.tsx
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
/**
* @author @abhi-arya1
* @license MIT
* @function App
* @fileoverview https://docs.google.com/document/d/1RSU4adTqKHaJnn8IgiJoPSRARFnAKAd_Uv6gaTrrB3Q/
*/

import { MemoryRouter as Router, Routes, Route } from 'react-router-dom';
import { StopwatchProvider } from '../providers/stopwatch_provider';
import HomePage from '../components/PAGES/home_page';
Expand Down

0 comments on commit 89b8785

Please sign in to comment.