update JSDocs

Author: gregrickaby

pages/[...slug].js

@@ -2,14 +2,10 @@ import getPostTypeStaticPaths from '@/api/wordpress/_global/getPostTypeStaticPat
 import getPostTypeStaticProps from '@/api/wordpress/_global/getPostTypeStaticProps'
 import Container from '@/components/atoms/Container'
 import RichText from '@/components/atoms/RichText'
-import BlockGravityForm from '@/components/blocks/Gutenberg/BlockGravityForm'
 import Layout from '@/components/common/Layout'
 import Blocks from '@/components/molecules/Blocks'
 import getPagePropTypes from '@/functions/getPagePropTypes'
 
-// TODO Remove BlockGravityForm once block support is added.
-// TODO Remove slug based BlockGravityForm from page render.
-
 // Define route post type.
 const postType = 'page'
 
@@ -19,7 +15,7 @@ const postType = 'page'
  * @author WebDevStudios
  * @param {object} props      The component attributes as props.
  * @param {object} props.post Post data from WordPress.
- * @return {Element} The Page component.
+ * @return {Element}          The Page component.
  */
 export default function Page({post}) {
   return (
@@ -29,9 +25,6 @@ export default function Page({post}) {
           <RichText tag="h1">{post?.title}</RichText>
           <Blocks blocks={post?.blocks} />
         </article>
-        {post?.slug === 'form-demo' && (
-          <BlockGravityForm {...post?.blocks[0]} />
-        )}
       </Container>
     </Layout>
   )
@@ -55,7 +48,7 @@ export async function getStaticPaths() {
  * @param {object}  context.params      Route parameters for current post.
  * @param {boolean} context.preview     Whether requesting preview of post.
  * @param {object}  context.previewData Post preview data.
- * @return {object} Post props.
+ * @return {object}                     Post props.
  */
 export async function getStaticProps({params, preview, previewData}) {
   return getPostTypeStaticProps(params, postType, preview, previewData)

pages/_app.js

@@ -1,14 +1,14 @@
 import {useApollo} from '@/api/apolloConfig'
-import '@/styles/index.css'
+import AlgoliaProvider from '@/components/common/AlgoliaProvider'
+import MenuProvider from '@/components/common/MenuProvider'
 import '@/styles/demo.css'
+import '@/styles/index.css'
 import {ApolloProvider} from '@apollo/client'
 import {DefaultSeo} from 'next-seo'
 import Error from 'next/error'
-import {useState, useEffect} from 'react'
-import PropTypes from 'prop-types'
-import AlgoliaProvider from '@/components/common/AlgoliaProvider'
-import MenuProvider from '@/components/common/MenuProvider'
 import {useRouter} from 'next/router'
+import PropTypes from 'prop-types'
+import {useEffect, useState} from 'react'
 
 /**
  * Render the App component.
@@ -17,7 +17,7 @@ import {useRouter} from 'next/router'
  * @param {object}  props           The component attributes as props.
  * @param {object}  props.Component Page component to display.
  * @param {boolean} props.pageProps Page component props.
- * @return {Element} The App component.
+ * @return {Element}                The App component.
  */
 export default function App({Component, pageProps}) {
   /**

pages/blog/[[...slug]].js

@@ -23,7 +23,7 @@ const postType = 'post'
  * @param {boolean} props.archive    Whether displaying single post (false) or archive (true).
  * @param {Array}   props.posts      Array of post data from WordPress.
  * @param {object}  props.pagination Archive pagination data from WordPress.
- * @return {Element} The BlogPost component.
+ * @return {Element}                 The BlogPost component.
  */
 export default function BlogPost({post, archive, posts, pagination}) {
   /**
@@ -99,7 +99,7 @@ export async function getStaticPaths() {
  * @param {object}  context.params      Route parameters for current post.
  * @param {boolean} context.preview     Whether requesting preview of post.
  * @param {object}  context.previewData Post preview data.
- * @return {object} Post props.
+ * @return {object}                     Post props.
  */
 export async function getStaticProps({params, preview, previewData}) {
   return getPostTypeStaticProps(params, postType, preview, previewData)

pages/index.js

@@ -1,7 +1,6 @@
 import getPostTypeStaticProps from '@/api/wordpress/_global/getPostTypeStaticProps'
 import Container from '@/components/atoms/Container'
 import Layout from '@/components/common/Layout'
-import Hero from '@/components/organisms/Hero'
 import getPagePropTypes from '@/functions/getPagePropTypes'
 import Page from './[...slug]'
 
@@ -29,11 +28,6 @@ export default function HomePage({post}) {
     <Layout seo={{...seo}}>
       <Container>
         <article>
-          <Hero
-            background="https://images.unsplash.com/photo-1513106021000-168e5f56609d?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=2560&q=70"
-            title="Next.js Starter"
-            description="A slightly opinionated, yet bare-bones Next.js starter."
-          />
           <p>
             To display your WordPress homepage dynamically, set your homepage to
             a static page via the WP dashboard (Settings: Reading Settings).

pages/team/[[...slug]].js

@@ -14,15 +14,15 @@ import getPagePropTypes from '@/functions/getPagePropTypes'
 const postType = 'team'
 
 /**
- * Render the BlogPost component.
+ * Render the Team component.
  *
  * @author WebDevStudios
  * @param {object}  props            The component attributes as props.
  * @param {object}  props.post       Post data from WordPress.
  * @param {boolean} props.archive    Whether displaying single post (false) or archive (true).
  * @param {Array}   props.posts      Array of post data from WordPress.
  * @param {object}  props.pagination Archive pagination data from WordPress.
- * @return {Element} The BlogPost component.
+ * @return {Element}                 The Team component.
  */
 export default function Team({post, archive, posts, pagination}) {
   /**
@@ -123,7 +123,7 @@ export async function getStaticPaths() {
  * @param {object}  context.params      Route parameters for current post.
  * @param {boolean} context.preview     Whether requesting preview of post.
  * @param {object}  context.previewData Post preview data.
- * @return {object} Post props.
+ * @return {object}                     Post props.
  */
 export async function getStaticProps({params, preview, previewData}) {
   return getPostTypeStaticProps(params, postType, preview, previewData)