mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
8a0b40502e
This change puts `combineDoclets` in the same place as methods like `clone` and `emptyDoclet`.
74 lines
2.3 KiB
JavaScript
74 lines
2.3 KiB
JavaScript
/*
|
|
Copyright 2011 the JSDoc Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
https://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* Functions that resolve `@borrows` tags in JSDoc comments.
|
|
*/
|
|
|
|
import { SCOPE } from '@jsdoc/name';
|
|
|
|
import { Doclet } from './doclet.js';
|
|
|
|
function cloneBorrowedDoclets({ borrowed, longname }, docletStore) {
|
|
borrowed?.forEach(({ from, as }) => {
|
|
const borrowedDoclets = docletStore.docletsByLongname.get(from);
|
|
let borrowedAs = as || from;
|
|
let parts;
|
|
let scopePunc;
|
|
|
|
if (borrowedDoclets) {
|
|
borrowedAs = borrowedAs.replace(/^prototype\./, SCOPE.PUNC.INSTANCE);
|
|
borrowedDoclets.forEach((borrowedDoclet) => {
|
|
const clone = Doclet.clone(borrowedDoclet);
|
|
|
|
// TODO: this will fail on longnames like '"Foo#bar".baz'
|
|
parts = borrowedAs.split(SCOPE.PUNC.INSTANCE);
|
|
|
|
if (parts.length === 2) {
|
|
clone.scope = SCOPE.NAMES.INSTANCE;
|
|
scopePunc = SCOPE.PUNC.INSTANCE;
|
|
} else {
|
|
clone.scope = SCOPE.NAMES.STATIC;
|
|
scopePunc = SCOPE.PUNC.STATIC;
|
|
}
|
|
|
|
clone.name = parts.pop();
|
|
clone.memberof = longname;
|
|
clone.longname = clone.memberof + scopePunc + clone.name;
|
|
docletStore.add(clone);
|
|
});
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Creates doclets for borrowed symbols, and adds them to the doclet store.
|
|
*
|
|
* The `name`, `memberof`, and `longname` properties for the new doclets are rewritten to show that
|
|
* they belong to the borrowing symbol.
|
|
*
|
|
* This method also removes the `borrowed` property from each borrowed doclet.
|
|
*
|
|
* @alias module:@jsdoc/doclet.resolveBorrows
|
|
* @param {!module:@jsdoc/doclet.DocletStore} docletStore - The doclet store to update.
|
|
*/
|
|
export function resolveBorrows(docletStore) {
|
|
for (const doclet of docletStore.docletsWithBorrowed) {
|
|
cloneBorrowedDoclets(doclet, docletStore);
|
|
doclet.borrowed = undefined;
|
|
}
|
|
}
|