Skip to content
This repository was archived by the owner on Feb 27, 2024. It is now read-only.

Commit ea015e5

Browse files
committed
Adding Docblocks
1 parent 4767c8d commit ea015e5

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

components/atoms/Logo/Logo.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
import Link from 'next/link'
22

3+
// TODO: Create Storybook for this component.
4+
35
export default function Logo() {
46
return (
57
<Link href="/">

components/common/ActiveLink.js

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ import PropTypes from 'prop-types'
44
import React, {Children} from 'react'
55

66
/**
7-
* Component to set an active link.
7+
* Render the ActiveLink Component.
88
*
99
* @author WebDevStudios
1010
* @see https://nextjs.org/docs/api-reference/next/link
11-
* @param {object} children Child objects for rendering.
12-
* @param {object} activeClass The classname for the active element.
13-
* @param {object} props.href The href to be added as a link.
11+
* @param {object} props props.
12+
* @param {object} props.children Child objects for rendering.
13+
* @param {string} props.activeClass The classname for the active element.
14+
* @param {object} props.href The href to be added as a link.
15+
* @return {Element} The ActiveLink component.
1416
*/
1517
export default function ActiveLink({children, activeClass, ...props}) {
1618
const {asPath} = useRouter()
@@ -20,7 +22,7 @@ export default function ActiveLink({children, activeClass, ...props}) {
2022
/**
2123
* Remove the last trailing slash from a URL path.
2224
*
23-
* @param {string} str String to replace /.
25+
* @param {string} str The string to search and replace /.
2426
* @return {string} Updated string.
2527
*/
2628
function stripTrailingSlash(str) {

components/molecules/Navigation/Navigation.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@ import cn from 'classnames'
33
import styles from './Navigation.module.css'
44

55
/**
6-
* @param props
6+
* Render the Navigation Component.
7+
*
8+
* @author WebDevStudios
9+
* @param {object} props props.
10+
* @param {array} props.menu Array of menu items.
11+
* @param {string} props.className Optional classname for the element.
12+
* @return {Element} The Navigation component.
713
*/
814
export default function Navigation({menu, className}) {
915
return (

0 commit comments

Comments
 (0)