Add jsdocs to pages

Author: ravewebdev

pages/[...slug].js

@@ -6,6 +6,14 @@ import PropTypes from 'prop-types'
 // Define route post type.
 const postType = 'page'
 
+/**
+ * Render the Page component.
+ *
+ * @author WebDevStudios
+ * @param {object} props      The component attributes as props.
+ * @param {object} props.post The post data object.
+ * @return {Element}          The Page component.
+ */
 export default function Page({post}) {
   return (
     <Layout
@@ -44,7 +52,7 @@ export default function Page({post}) {
  * Get post static paths.
  *
  * @author WebDevStudios
- * @return {Object} Object consisting of array of paths and fallback setting.
+ * @return {object} Object consisting of array of paths and fallback setting.
  */
 export async function getStaticPaths() {
   return await getPostTypeStaticPaths(postType)
@@ -53,11 +61,11 @@ export async function getStaticPaths() {
 /**
  * Get post static props.
  *
- * @param  {Object}  context             Context for current post.
- * @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.
+ * @param {object}  context             Context for current post.
+ * @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.
  */
 export async function getStaticProps({params}) {
   return getPostTypeStaticProps(params, postType)

pages/index.js

@@ -7,6 +7,14 @@ import Page from './[...slug]'
 // Define route post type.
 const postType = 'page'
 
+/**
+ * Render the HomePage component.
+ *
+ * @author WebDevStudios
+ * @param {object} props      The component attributes as props.
+ * @param {object} props.post The post data object.
+ * @return {Element}          The HomePage component.
+ */
 export default function HomePage({post}) {
   // Display dynamic page data if homepage retrieved from WP.
   if (post) {
@@ -47,10 +55,10 @@ export default function HomePage({post}) {
 /**
  * Get post static props.
  *
- * @param  {Object}  context             Context for current post.
- * @param  {boolean} context.preview     Whether requesting preview of post.
- * @param  {Object}  context.previewData Post preview data.
- * @return {Object}                      Post props.
+ * @param {object}  context             Context for current post.
+ * @param {boolean} context.preview     Whether requesting preview of post.
+ * @param {object}  context.previewData Post preview data.
+ * @return {object}                      Post props.
  */
 export async function getStaticProps() {
   return await getPostTypeStaticProps({slug: '/'}, postType)

pages/search.js

@@ -6,7 +6,10 @@ import {useRouter} from 'next/router'
 import config from '@/functions/config'
 
 /**
- * The Search component displays the search page.
+ * Render the Search component.
+ *
+ * @author WebDevStudios
+ * @return {Element} The Search component.
  */
 export default function Search() {
   const router = useRouter()
@@ -27,10 +30,10 @@ export default function Search() {
 /**
  * Get post static props.
  *
- * @param  {Object}  context             Context for current post.
- * @param  {boolean} context.preview     Whether requesting preview of post.
- * @param  {Object}  context.previewData Post preview data.
- * @return {Object}                      Post props.
+ * @param {object}  context             Context for current post.
+ * @param {boolean} context.preview     Whether requesting preview of post.
+ * @param {object}  context.previewData Post preview data.
+ * @return {object}                      Post props.
  */
 export async function getStaticProps() {
   return await getPostTypeStaticProps({slug: '/'}, 'search')