PR review updates to DocBlocks

Author: dcooney

components/atoms/Logo/Logo.js

@@ -1,7 +1,12 @@
 import Link from 'next/link'
 
+/**
+ * Render the Logo component.
+ *
+ * @author WebDevStudios
+ * @return {Element}     The Blocks component.
+ */
 // TODO: Create Storybook for this component.
-
 export default function Logo() {
   return (
     <Link href="/">

components/atoms/RichText/RichText.js

@@ -4,9 +4,19 @@ import PropTypes from 'prop-types'
 import React from 'react'
 import styles from './RichText.module.css'
 
+/**
+ * Render the RichText component.
+ *
+ * @param {object} props            RichText component props.
+ * @param {string} props.attributes Optional element attributes.
+ * @param {string} props.children   Child component(s) to render.
+ * @param {string} props.className  Optional classNames.
+ * @param {string} props.id         Optional element ID.
+ * @param {string} props.tag        The type of element to render.
+ * @return {Element}                The RichText component.
+ */
 export default function RichText({attributes, children, className, id, tag}) {
   const tagClassName = tag !== 'div' ? tag : ''
-
   return React.createElement(tag, {
     ...attributes,
     className: cn(styles.richtext, styles?.[tagClassName], className),

components/molecules/Blocks/Blocks.js

@@ -5,16 +5,17 @@ import displayBlock from '@/functions/displayBlock'
 /**
  * Render the Blocks component.
  *
- * @param {array} blocks An array of blocks.
- * @return {Element}     The Blocks component.
+ * @author WebDevStudios
+ * @param {object} props        The component attributes as props.
+ * @param {array}  props.blocks The array of blocks.
+ * @return {Element}            The Blocks component.
  */
 export default function Blocks({blocks}) {
   return (
     <>
       {
         // If there are blocks, loop over and display.
-        !!blocks &&
-          blocks.length > 0 &&
+        !!blocks?.length &&
           blocks.map((block, index) => {
             return displayBlock(block, index)
           })

functions/createMarkup.js

@@ -1,7 +1,9 @@
 /**
  * Handle markup that contains HTML.
  *
+ * @author WebDevStudios
  * @param {Array} props Array of JSX Objects.
+ * @return {object}     HTML markup for rendering.
  */
 export default function createMarkup(props) {
   return {__html: props}