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

Commit 87e15eb

Browse files
committed
Fix jsdoc
1 parent 62e6fb5 commit 87e15eb

File tree

20 files changed

+110
-104
lines changed

20 files changed

+110
-104
lines changed

components/blocks/Gutenberg/BlockAccordions/BlockAccordions.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ import PropTypes from 'prop-types'
66
* A custom ACF Block for displaying accordions.
77
*
88
* @author WebDevStudios
9-
* @param props.props
10-
* @param {object} props The component attributes as props.
9+
* @param props.props.props
10+
* @param props.props.props.props
11+
* @param {object} props.props The component attributes as props.
1112
*/
1213
export default function BlockAccordions({props}) {
1314
const {

components/blocks/Gutenberg/BlockButton/BlockButton.js

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@ import PropTypes from 'prop-types'
77
* The core Button block from Gutenberg.
88
*
99
* @author WebDevStudios
10-
* @param {string} anchor Optional anchor/id.
11-
* @param {string} className Optional classnames.
12-
* @param {string} linkTarget The target for the link.
13-
* @param {string} rel The rel attribute for the link.
14-
* @param {string} text The link label.
15-
* @param {string} title The target for the link.
16-
* @param {string} url The link for the button.
10+
* @param {object} props The component properties.
11+
* @param {string} props.anchor Optional anchor/id.
12+
* @param {string} props.className Optional classnames.
13+
* @param {string} props.linkTarget The target for the link.
14+
* @param {string} props.rel The rel attribute for the link.
15+
* @param {string} props.text The link label.
16+
* @param {string} props.title The target for the link.
17+
* @param {string} props.url The link for the button.
1718
* @return {Element} The Button component.
1819
*/
1920
export default function BlockButton({

components/blocks/Gutenberg/BlockButtons/BlockButtons.js

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,10 @@ import PropTypes from 'prop-types'
88
* The core Buttons block from Gutenberg.
99
*
1010
* @author WebDevStudios
11-
* @param {object} props The component properties.
12-
* @param props.options
13-
* @param {object} options Option props object.
14-
* @param {string} options.anchor The anchor/id of the block.
15-
* @param {string} options.orientation The orientation of buttons.
16-
* @param {string} options.contentJustification The justification of the buttons.
17-
* @param props.innerBlocks
18-
* @param {Array} innerBlocks The array of inner blocks to display.
19-
* @return {Element} The Buttons component.
11+
* @param {object} props The component properties.
12+
* @param {object} props.options Option props object.
13+
* @param {Array} props.innerBlocks The array of inner blocks to display.
14+
* @return {Element} The Buttons component.
2015
*/
2116
export default function BlockButtons({options, innerBlocks}) {
2217
return (

components/blocks/Gutenberg/BlockCode/BlockCode.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ import PropTypes from 'prop-types'
77
* The core Code block from Gutenberg.
88
*
99
* @author WebDevStudios
10-
* @param {string} className Optional classnames.
11-
* @param {string} anchor Optional anchor/id.
12-
* @param {string} content The content of the block.
13-
* @return {Element} The Code component.
10+
* @param {object} props The component props.
11+
* @param {string} props.className Optional classnames.
12+
* @param {string} props.anchor Optional anchor/id.
13+
* @param {string} props.content The content of the block.
14+
* @return {Element} The Code component.
1415
*/
1516
export default function BlockCode({anchor, className, content}) {
1617
return <Code className={className} id={anchor} content={content} />

components/blocks/Gutenberg/BlockColumns/BlockColumns.js

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,9 @@ import PropTypes from 'prop-types'
88
* The core Columns block from Gutenberg.
99
*
1010
* @author WebDevStudios
11-
* @param {object} props The component properties.
12-
* @param {string} options.anchor The optional anchor/id of the block.
13-
* @param {string} options.className The optional classname.
14-
* @param props.options
15-
* @param props.innerBlocks
16-
* @param {Array} innerBlocks The array of inner blocks to display.
11+
* @param {object} props The component properties.
12+
* @param {object} props.options Option props object.
13+
* @param {object} props.innerBlocks The array of inner blocks to display.
1714
* @return {Element} The Columns component.
1815
*/
1916
export default function BlockColumns({options, innerBlocks}) {

components/blocks/Gutenberg/BlockCover/BlockCover.js

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,10 @@ import PropTypes from 'prop-types'
88
* The core Columns block from Gutenberg.
99
*
1010
* @author WebDevStudios
11-
* @param {object} props The component properties.
12-
* @param {string} media.anchor The optional anchor/id of the block.
13-
* @param {string} media.url The background image URL.
14-
* @param props.media
15-
* @param props.innerBlocks
16-
* @param {Array} innerBlocks The array of inner blocks to display.
17-
* @return {Element} The Cover component.
11+
* @param {object} props The component properties.
12+
* @param {object} props.media Media props object.
13+
* @param {Array} props.innerBlocks The array of inner blocks to display.
14+
* @return {Element} The Cover component.
1815
*/
1916
export default function BlockCover({media, innerBlocks}) {
2017
return (

components/blocks/Gutenberg/BlockGravityForm/BlockGravityForm.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import PropTypes from 'prop-types'
55
* GravityForm block.
66
*
77
* @author WebDevStudios
8-
* @param props.attributes
9-
* @param {object} props The component attributes as props.
8+
* @param {object} props The component props.
9+
* @param {object} props.attributes Component attributes.
1010
*/
1111
export default function BlockGravityForm({attributes}) {
1212
return <GravityForm {...attributes} />

components/blocks/Gutenberg/BlockHeadings/BlockHeadings.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ import React from 'react'
99
* The core Headings block from Gutenberg.
1010
*
1111
* @author WebDevStudios
12-
* @param {string} className Optional classnames.
13-
* @param {string} align Optional alignment style.
14-
* @param {string} anchor Optional anchor/id.
15-
* @param {string} content The content of the block.
16-
* @param {string} level The heading level.
17-
* @return {Element} The RichText component.
12+
* @param {object} props The component props.
13+
* @param {string} props.className Optional classnames.
14+
* @param {string} props.align Optional alignment style.
15+
* @param {string} props.anchor Optional anchor/id.
16+
* @param {string} props.content The content of the block.
17+
* @param {string} props.level The heading level.
18+
* @return {Element} The RichText component.
1819
*/
1920
export default function BlockHeadings({
2021
className,

components/blocks/Gutenberg/BlockImage/BlockImage.js

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,19 @@ import PropTypes from 'prop-types'
77
* The core Image block from Gutenberg.
88
*
99
* @author WebDevStudios
10-
* @param {string} anchor The anchor/id of the block.
11-
* @param {string} alt The image alt text.
12-
* @param {string} caption The image caption.
13-
* @param {string} className The image class.
14-
* @param {string} id The image ID.
15-
* @param {string} href The URL of the link.
16-
* @param {string} linkTarget Target for the link.
17-
* @param {string} linkClass Class for the link.
18-
* @param {string} rel The rel attribute for the link.
19-
* @param {string} sizeSlug The WP image size.
20-
* @param {string} url The full URL path of the image.
21-
* @return {Element} The Image component.
10+
* @param {object} props The component props.
11+
* @param {string} props.anchor The anchor/id of the block.
12+
* @param {string} props.alt The image alt text.
13+
* @param {string} props.caption The image caption.
14+
* @param {string} props.className The image class.
15+
* @param {string} props.id The image ID.
16+
* @param {string} props.href The URL of the link.
17+
* @param {string} props.linkTarget Target for the link.
18+
* @param {string} props.linkClass Class for the link.
19+
* @param {string} props.rel The rel attribute for the link.
20+
* @param {string} props.sizeSlug The WP image size.
21+
* @param {string} props.url The full URL path of the image.
22+
* @return {Element} The Image component.
2223
*/
2324
export default function BlockImage({
2425
alt,

components/blocks/Gutenberg/BlockImageGallery/BlockImageGallery.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@ import PropTypes from 'prop-types'
77
* The core Image Gallery block from Gutenberg.
88
*
99
* @author WebDevStudios
10-
* @param {string} anchor The anchor/id of the block.
11-
* @param {string} caption The image caption.
12-
* @param {string} className The image class.
13-
* @param {number} columns The amount of columns.
14-
* @param {Array} images The array of images.
15-
* @return {Element} The ImageGallery component.
10+
* @param {object} props The component props.
11+
* @param {string} props.anchor The anchor/id of the block.
12+
* @param {string} props.caption The image caption.
13+
* @param {string} props.className The image class.
14+
* @param {number} props.columns The amount of columns.
15+
* @param {Array} props.images The array of images.
16+
* @return {Element} The ImageGallery component.
1617
*/
1718
export default function BlockImageGallery({
1819
anchor,

0 commit comments

Comments
 (0)