@wordpress/docgen 1.23.0 → 1.24.0

package/lib/index.js

@@ -11,6 +11,7 @@ const { last } = require( 'lodash' );
 const engine = require( './engine' );
 const defaultMarkdownFormatter = require( './markdown' );
 const isSymbolPrivate = require( './is-symbol-private' );
+const isSymbolIgnore = require( './is-symbol-ignore' );
 
 /**
  * Helpers functions.
@@ -119,7 +120,7 @@ module.exports = ( sourceFile, options ) => {
 	// Process.
 	const result = processFile( processDir, sourceFile );
 	const filteredIR = result.ir.filter( ( symbol ) => {
-		if ( isSymbolPrivate( symbol ) ) {
+		if ( isSymbolPrivate( symbol ) || isSymbolIgnore( symbol ) ) {
 			return false;
 		}
 

package/lib/is-symbol-ignore.js

@@ -0,0 +1,17 @@
+/**
+ * Internal dependencies
+ */
+const getSymbolTagsByName = require( './get-symbol-tags-by-name' );
+
+/**
+ * Returns true if, given a symbol object, it contains a @ignore tag, or false
+ * otherwise.
+ *
+ * @param {Object} symbol Symbol object.
+ *
+ * @return {boolean} Whether symbol is private.
+ */
+const isSymbolIgnore = ( symbol ) =>
+	getSymbolTagsByName( symbol, 'ignore' ).length > 0;
+
+module.exports = isSymbolIgnore;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/docgen",
-	"version": "1.23.0",
+	"version": "1.24.0",
 	"description": "Autogenerate public API documentation from exports and JSDoc comments.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -39,5 +39,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "a80eeb62ec7cb1418b9915c277e084a29d6665e3"
+	"gitHead": "9d9d33bbdf317a4381b8ca1713e43bb50df653b3"
 }