archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

perf: optimize hot method

Browse Source
This commit is contained in:
Jeff Williams 2024-12-29 16:21:20 -08:00
parent a3d67f77a9
commit e7432611b6
No known key found for this signature in database
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
packages/jsdoc-doclet/lib/doclet.js
View File

@ -41,9 +41,13 @@ export let Doclet;
const ACCESS_LEVELS = ['package', 'private', 'protected', 'public'];
const ALL_SCOPE_NAMES = _.values(SCOPE.NAMES);
const CLASSDESC_TAG = '@classdesc';
const DEFAULT_SCOPE = SCOPE.NAMES.STATIC;
const DESCRIPTION_TAG = '@description';
// TODO: `class` should be on this list, right? What are the implications of adding it?
const GLOBAL_KINDS = ['constant', 'function', 'member', 'typedef'];
const REGEXP_COMMENT_STARTS_WITH_TAG = /^\s*@/;
const REGEXP_ONLY_WHITESPACE = /^\s*$/;
export const WATCHABLE_PROPS = [
'access',
@ -164,14 +168,18 @@ function toTags(docletSrc) {
return tagData;
}
// If no tag is present at the start of the doclet source, then add a JSDoc tag, so that the initial
// text is treated as a description.
function fixDescription(docletSrc, { code }) {
let isClass;
let newTag;
if (!/^\s*@/.test(docletSrc) && docletSrc.replace(/\s/g, '').length) {
isClass =
code && (code.type === Syntax.ClassDeclaration || code.type === Syntax.ClassExpression);
if (!REGEXP_COMMENT_STARTS_WITH_TAG.test(docletSrc) && !REGEXP_ONLY_WHITESPACE.test(docletSrc)) {
newTag =
code?.type === Syntax.ClassDeclaration || code?.type === Syntax.ClassExpression
? CLASSDESC_TAG
: DESCRIPTION_TAG;
docletSrc = `${isClass ? '@classdesc' : '@description'} ${docletSrc}`;
docletSrc = newTag + ' ' + docletSrc;
}
return docletSrc;