diff --git a/src/App.tsx b/src/App.tsx index fecd659..82d9ffa 100644 --- a/src/App.tsx +++ b/src/App.tsx @@ -3,6 +3,7 @@ import {BrowserRouter} from 'react-router-dom'; import NavBar from './components/NavBar'; import Router from './router/Router'; +/** Main App container */ const App = () => { return ( diff --git a/src/components/DevProfile.tsx b/src/components/DevProfile.tsx index 0f6d097..9c19076 100644 --- a/src/components/DevProfile.tsx +++ b/src/components/DevProfile.tsx @@ -1,8 +1,12 @@ import React, {FC} from 'react'; import {FontAwesomeIcon} from '@fortawesome/react-fontawesome'; import {faCheck} from '@fortawesome/free-solid-svg-icons'; -import DevSummary from '../models/DevSummary'; +import {DevSummary} from '../models/Dev'; +/** + * Present a dev profile succintly. Redirect to dev profile on click. + * @param props DevSummary object + */ const DevProfile: FC = ({ id, name, diff --git a/src/components/FormHeader.tsx b/src/components/FormHeader.tsx index a13e1ba..2a671e8 100644 --- a/src/components/FormHeader.tsx +++ b/src/components/FormHeader.tsx @@ -7,6 +7,7 @@ interface IProps { icon?: string; } +/** Header component displayed on form pages */ const FormHeader: FC = props => ( <>
diff --git a/src/components/Header.tsx b/src/components/Header.tsx index efad761..bcfb935 100644 --- a/src/components/Header.tsx +++ b/src/components/Header.tsx @@ -13,6 +13,12 @@ interface IProps { icon?: string; } +/** + * Header component + * @param title of the page + * @param lead description of the content + * @param icon to display (optional and default to faUser) + */ const Header: FC = ({title, lead, icon = 'faUser'}) => { const RenderIcon = (icon: string) => { if (icon === 'faUser') { diff --git a/src/components/NavBar.tsx b/src/components/NavBar.tsx index 32bf5fc..a88a8f8 100644 --- a/src/components/NavBar.tsx +++ b/src/components/NavBar.tsx @@ -2,11 +2,14 @@ import React, {FC} from 'react'; import {FontAwesomeIcon} from '@fortawesome/react-fontawesome'; import {faCode} from '@fortawesome/free-solid-svg-icons'; +/** + * Main Navbar serves navigation routes. + */ const NavBar: FC = () => (