diff --git a/packages/jsdoc-plugins/lib/cleanup.js b/packages/jsdoc-plugins/lib/cleanup.js index 03b4f637b..f415f4760 100644 --- a/packages/jsdoc-plugins/lib/cleanup.js +++ b/packages/jsdoc-plugins/lib/cleanup.js @@ -66,11 +66,6 @@ exports.handlers = { ); } - // Filter out private doclet classes. - // if ( doclet.kind === 'class' && doclet.access === 'private' ) { - // return false; - // } - return true; } ); } diff --git a/packages/jsdoc-plugins/lib/longname-fixer/fixers/convert-short-refs-to-full-refs.js b/packages/jsdoc-plugins/lib/longname-fixer/fixers/convert-short-refs-to-full-refs.js index 7e4dc73b1..9a40aff55 100644 --- a/packages/jsdoc-plugins/lib/longname-fixer/fixers/convert-short-refs-to-full-refs.js +++ b/packages/jsdoc-plugins/lib/longname-fixer/fixers/convert-short-refs-to-full-refs.js @@ -8,7 +8,7 @@ const assign = Object.assign; /** - * @param {Array.} doclets + * @param {Array.} doclets */ function convertShortRefsToFullRefs( doclets ) { addMissingModulePart( doclets ); @@ -18,7 +18,7 @@ function convertShortRefsToFullRefs( doclets ) { convertShortRefsInLinks( doclets ); } -/** @param {Doclet[]} doclets */ +/** @param {Array.} doclets */ function addMissingModulePart( doclets ) { /** @type {Record} */ const fileNameModuleDoclets = {}; @@ -47,7 +47,7 @@ function addMissingModulePart( doclets ) { } } -/** @param {Doclet[]} doclets */ +/** @param {Array.} doclets */ function convertShortRefsInLongnameAndMemberof( doclets ) { const fileDoclets = groupDocletsByFiles( doclets ); @@ -85,7 +85,7 @@ function convertShortRefsInLongnameAndMemberof( doclets ) { } } -/** @param {Doclet[]} doclets */ +/** @param {Array.} doclets */ function convertShortRefsInFireTag( doclets ) { for ( const doclet of doclets ) { if ( !doclet.fires ) { @@ -110,7 +110,7 @@ function convertShortRefsInFireTag( doclets ) { } } -/** @param {Doclet[]} doclets */ +/** @param {Array.} doclets */ function convertShortRefsInSeeTag( doclets ) { /** @type {Doclet} */ let lastInterfaceOrClass; @@ -185,10 +185,10 @@ function convertShortRefsInLinks( doclets ) { } /** - * @param {Doclet[]} doclets + * @param {Array.} doclets */ function groupDocletsByFiles( doclets ) { - /** @type {Record.}*/ + /** @type {Record.>}*/ const files = {}; for ( const doclet of doclets ) { @@ -205,7 +205,7 @@ function groupDocletsByFiles( doclets ) { /** * Finds within the same file the parent doclet (`class`, `interface` or `mixin`). * - * @param {Doclet[]} fileDoclets + * @param {Array.} fileDoclets * @param {Doclet} doclet */ function getCorrespondingParent( fileDoclets, doclet ) { diff --git a/packages/jsdoc-plugins/lib/longname-fixer/fixers/fix-incorrect-class-constructor.js b/packages/jsdoc-plugins/lib/longname-fixer/fixers/fix-incorrect-class-constructor.js index f889491cb..a942db875 100644 --- a/packages/jsdoc-plugins/lib/longname-fixer/fixers/fix-incorrect-class-constructor.js +++ b/packages/jsdoc-plugins/lib/longname-fixer/fixers/fix-incorrect-class-constructor.js @@ -13,7 +13,7 @@ const { isEqual } = require( 'lodash' ); * JSDoc completely messes up doclets for constructors and classes. * They are duplicated (where the only one contains valuable data), have invalid descriptions, etc. * - * @param {Doclet[]} doclets + * @param {Array.} doclets */ module.exports = function fixIncorrectClassConstructor( doclets ) { const knownConstructorDoclets = new Set(); @@ -64,9 +64,5 @@ module.exports = function fixIncorrectClassConstructor( doclets ) { } knownDoclets.set( doclet.longname, doclet ); - - // if ( doclet.inheritdoc === '' ) { - // doclet.ignore = true; - // } } }; diff --git a/packages/jsdoc-plugins/lib/relation-fixer/addtypedefproperties.js b/packages/jsdoc-plugins/lib/relation-fixer/addtypedefproperties.js index 6b82d36a0..5440b85cb 100644 --- a/packages/jsdoc-plugins/lib/relation-fixer/addtypedefproperties.js +++ b/packages/jsdoc-plugins/lib/relation-fixer/addtypedefproperties.js @@ -78,7 +78,7 @@ function extendTypedef( typedef, typedefDoclets ) { /** * Creates and returns doclets for `@typedef` properties. * - * @param {Doclet[]} typedefDoclets + * @param {Array.} typedefDoclets */ function createTypedefPropertyDoclets( typedefDoclets ) { const typedefPropertyDoclets = []; diff --git a/packages/jsdoc-plugins/lib/relation-fixer/filteroutintenraldoclets.js b/packages/jsdoc-plugins/lib/relation-fixer/filteroutintenraldoclets.js index 8cd4b2b5e..6c0a0918d 100644 --- a/packages/jsdoc-plugins/lib/relation-fixer/filteroutintenraldoclets.js +++ b/packages/jsdoc-plugins/lib/relation-fixer/filteroutintenraldoclets.js @@ -11,11 +11,7 @@ * @param {Array.} doclets */ module.exports = function filterOutInternalDoclets( doclets ) { - doclets = doclets + return doclets .filter( doclet => !doclet.ignore ) .filter( doclet => doclet.memberof != '' ); - - // return filterOutReExportedSymbols( doclets ); - - return doclets; }; diff --git a/packages/jsdoc-plugins/lib/relation-fixer/getmissingdocletsdata.js b/packages/jsdoc-plugins/lib/relation-fixer/getmissingdocletsdata.js index acc4aac4d..cb1e3d5c0 100644 --- a/packages/jsdoc-plugins/lib/relation-fixer/getmissingdocletsdata.js +++ b/packages/jsdoc-plugins/lib/relation-fixer/getmissingdocletsdata.js @@ -81,7 +81,7 @@ function getDocletsToAdd( docletCollection, childDoclet, options ) { // Longnames of doclets which are related ( extended, mixed, implemented ) to childDoclet. const ancestors = childDoclet[ options.relation ] || []; - /** @type {Doclet[]} */ + /** @type {Array.} */ const docletsToAdd = []; for ( const ancestor of ancestors ) { diff --git a/packages/jsdoc-plugins/lib/relation-fixer/index.js b/packages/jsdoc-plugins/lib/relation-fixer/index.js index 733a23579..b701fc3f4 100644 --- a/packages/jsdoc-plugins/lib/relation-fixer/index.js +++ b/packages/jsdoc-plugins/lib/relation-fixer/index.js @@ -24,11 +24,11 @@ exports.handlers = { * Revert missing doclets that were marked as ignored. * Remove ignored doclets. * - * @param {Doclet[]} doclets + * @param {Array.} doclets */ function precleanInheritance( doclets ) { // Group doclet by longnames - /** @type {Map.} */ + /** @type {Map.>} */ const docletMap = new Map(); for ( const doclet of doclets ) {