@wordpress/docgen 1.39.0 → 1.41.0

package/lib/get-jsdoc-from-token.js

@@ -28,9 +28,19 @@ module.exports = ( token ) => {
 			let paramCount = 0;
 
 			jsdoc.tags = jsdoc.tags.map( ( tag ) => {
+				const isParam = tag.tag === 'param';
 				const isUnqualifiedParam =
-					tag.tag === 'param' && ! tag.name.includes( '.' );
-				const index = isUnqualifiedParam ? paramCount++ : paramCount;
+					isParam && ! tag.name.includes( '.' );
+				let index = isUnqualifiedParam ? paramCount++ : paramCount;
+
+				// Qualified parameters come after an unqualified parameter. When
+				// the paramCount is incremented for an unqualified parameter, we
+				// still need to access that previous index. In other words, the
+				// qualified parameter types exist at the index of the previous
+				// unqualified parameter. As a result, the index is actually less.
+				if ( isParam && index > 0 && ! isUnqualifiedParam ) {
+					index -= 1;
+				}
 
 				return {
 					...tag,

package/lib/markdown/formatter.js

@@ -1,3 +1,8 @@
+/**
+ * External dependencies
+ */
+const remark = require( 'remark' );
+
 /**
  * Internal dependencies
  */
@@ -68,9 +73,26 @@ const formatDeprecated = ( tags, docs ) => {
 };
 
 const formatDescription = ( description, docs ) => {
+	const processor = remark().use( () => {
+		return function transformer( tree ) {
+			tree.children.forEach( function ( node ) {
+				if ( node.children ) {
+					transformer( node );
+				}
+				if ( node.type === 'text' && node.value ) {
+					// Replace line breaks with spaces and remove line-ending hyphens.
+					node.value = node.value
+						.replace( /([A-Za-z])-\n([A-Za-z])/g, '$1$2' )
+						.replace( /\n/g, ' ' );
+				}
+			} );
+		};
+	} );
+	const processedDescription = processor.processSync( description );
+
 	docs.push( '\n' );
 	docs.push( '\n' );
-	docs.push( description );
+	docs.push( processedDescription );
 };
 
 const getHeading = ( index, text ) => {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/docgen",
-	"version": "1.39.0",
+	"version": "1.41.0",
 	"description": "Autogenerate public API documentation from exports and JSDoc comments.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -38,5 +38,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "d5c28a67b11e91e3e4b8e90346bfcb90909364d6"
+	"gitHead": "6df0c62d43b8901414ccd22ffbe56eaa99d012a6"
 }