docs: tidy JSDoc and TSDoc

Author: remarkablemark

index.d.ts

@@ -43,9 +43,9 @@ export interface HTMLReactParserOptions {
 /**
  * Converts HTML string to JSX element(s).
  *
- * @param  html    - HTML string.
- * @param  options - Parser options.
- * @return         - JSX element(s), empty array, or string.
+ * @param html - HTML string.
+ * @param options - Parser options.
+ * @returns - JSX element(s), empty array, or string.
  */
 export default function HTMLReactParser(
   html: string,

index.js

@@ -12,12 +12,12 @@ var domParserOptions = { lowerCaseAttributeNames: false };
 /**
  * Converts HTML string to React elements.
  *
- * @param  {String}   html                    - HTML string.
- * @param  {Object}   [options]               - Parser options.
- * @param  {Object}   [options.htmlparser2]   - htmlparser2 options.
- * @param  {Object}   [options.library]       - Library for React, Preact, etc.
- * @param  {Function} [options.replace]       - Replace method.
- * @return {JSX.Element|JSX.Element[]|String} - React element(s), empty array, or string.
+ * @param {string} html - HTML string.
+ * @param {object} [options] - Parser options.
+ * @param {object} [options.htmlparser2] - htmlparser2 options.
+ * @param {object} [options.library] - Library for React, Preact, etc.
+ * @param {Function} [options.replace] - Replace method.
+ * @returns {JSX.Element|JSX.Element[]|string} - React element(s), empty array, or string.
  */
 function HTMLReactParser(html, options) {
   if (typeof html !== 'string') {

lib/attributes-to-props.d.ts

@@ -9,7 +9,7 @@ export type Props = Record<string, string> & {
 /**
  * Converts HTML/SVG DOM attributes to React props.
  *
- * @param  attributes - HTML/SVG DOM attributes.
- * @return            - React props.
+ * @param attributes - HTML/SVG DOM attributes.
+ * @returns - React props.
  */
 export default function attributesToProps(attributes: Attributes): Props;

lib/attributes-to-props.js

@@ -4,8 +4,8 @@ var utilities = require('./utilities');
 /**
  * Converts HTML/SVG DOM attributes to React props.
  *
- * @param  {object} [attributes={}] - HTML/SVG DOM attributes.
- * @return {object}                 - React props.
+ * @param {object} [attributes={}] - HTML/SVG DOM attributes.
+ * @returns - React props.
  */
 module.exports = function attributesToProps(attributes) {
   attributes = attributes || {};
@@ -79,7 +79,7 @@ module.exports = function attributesToProps(attributes) {
  * Gets prop name from lowercased attribute name.
  *
  * @param {string} attributeName - Lowercased attribute name.
- * @return {string}
+ * @returns - Prop name.
  */
 function getPropName(attributeName) {
   return reactProperty.possibleStandardNames[attributeName];

lib/dom-to-react.d.ts

@@ -7,9 +7,9 @@ export { DOMNode, HTMLReactParserOptions };
 /**
  * Converts DOM nodes to JSX element(s).
  *
- * @param  nodes   - DOM nodes.
- * @param  options - Parser options.
- * @return         - JSX element(s).
+ * @param nodes - DOM nodes.
+ * @param options - Parser options.
+ * @returns - JSX element(s).
  */
 export default function domToReact(
   nodes: DOMNode[],

lib/dom-to-react.js

@@ -8,11 +8,11 @@ var canTextBeChildOfNode = utilities.canTextBeChildOfNode;
 /**
  * Converts DOM nodes to JSX element(s).
  *
- * @param  {DomElement[]} nodes             - DOM nodes.
- * @param  {object}       [options={}]      - Options.
- * @param  {Function}     [options.replace] - Replacer.
- * @param  {object}       [options.library] - Library (React/Preact/etc.).
- * @return {string|JSX.Element|JSX.Element[]}
+ * @param {DomElement[]} nodes - DOM nodes.
+ * @param {object} [options={}] - Options.
+ * @param {Function} [options.replace] - Replacer.
+ * @param {object} [options.library] - Library (React, Preact, etc.).
+ * @returns - String or JSX element(s).
  */
 function domToReact(nodes, options) {
   options = options || {};
@@ -125,8 +125,8 @@ function domToReact(nodes, options) {
  * Determines whether DOM element attributes should be transformed to props.
  * Web Components should not have their attributes transformed except for `style`.
  *
- * @param  {DomElement} node
- * @return {boolean}
+ * @param {DomElement} node
+ * @returns - Whether node attributes should be converted to props.
  */
 function skipAttributesToProps(node) {
   return (

lib/utilities.js

@@ -4,9 +4,9 @@ var styleToJS = require('style-to-js').default;
 /**
  * Swap key with value in an object.
  *
- * @param  {Object}   obj        - The object.
- * @param  {Function} [override] - The override method.
- * @return {Object}              - The inverted object.
+ * @param {object} obj - The object.
+ * @param {Function} [override] - The override method.
+ * @returns - The inverted object.
  */
 function invertObject(obj, override) {
   if (!obj || typeof obj !== 'object') {
@@ -44,8 +44,8 @@ function invertObject(obj, override) {
  * @see {@link https://github.com/facebook/react/blob/v16.6.3/packages/react-dom/src/shared/isCustomComponent.js}
  *
  * @param {string} tagName - The name of the html tag.
- * @param {Object} props   - The props being passed to the element.
- * @return {boolean}
+ * @param {object} props - The props being passed to the element.
+ * @returns - Whether tag is custom component.
  */
 function isCustomComponent(tagName, props) {
   if (tagName.indexOf('-') === -1) {
@@ -113,8 +113,8 @@ var elementsWithNoTextChildren = new Set([
 /**
  * Checks if the given node can contain text nodes
  *
- * @param {DomElement} node
- * @returns {boolean}
+ * @param {DomElement} node - Node.
+ * @returns - Whether node can contain text nodes.
  */
 function canTextBeChildOfNode(node) {
   return !elementsWithNoTextChildren.has(node.name);

rollup.config.js

@@ -5,8 +5,8 @@ import { terser } from 'rollup-plugin-terser';
 /**
  * Build rollup config for development (default) or production (minify = true).
  *
- * @param {Boolean} [minify=false]
- * @return {Object}
+ * @param {boolean} [minify=false]
+ * @returns - Rollup config.
  */
 const getConfig = (minify = false) => ({
   external: ['react'],

test/helpers/index.js

@@ -3,7 +3,7 @@ const { renderToStaticMarkup } = require('react-dom/server');
 /**
  * Renders a React element to static HTML markup.
  *
- * @param  {ReactElement} reactElement - React element.
- * @return {string}                    - HTML markup.
+ * @param {ReactElement} reactElement - React element.
+ * @returns {string} - HTML markup.
  */
-module.exports.render = reactElement => renderToStaticMarkup(reactElement);
+exports.render = reactElement => renderToStaticMarkup(reactElement);