Function addSymbolMemberof

lib/jsdoc/src/handlers.js:235–285

(parser, doclet, astNode)

}

function addSymbolMemberof(parser, doclet, astNode) {
    let basename;
    let memberof;
    let memberofInfo;
    let moduleOriginalName = '';
    let resolveTargetRegExp;
    let scopePunc;
    let unresolved;

    if (!astNode) {
        return;
    }

    // check to see if the doclet name is an unresolved reference to the module object, or to `this`
    // TODO: handle cases where the module object is shadowed in the current scope
    if (currentModule) {
        moduleOriginalName = `|${currentModule.originalName}`;
    }
    resolveTargetRegExp = new RegExp(`^((?:module.)?exports|this${moduleOriginalName})(\\.|\\[|$)`);
    unresolved = resolveTargetRegExp.exec(doclet.name);

    if (unresolved) {
        memberofInfo = findSymbolMemberof(parser, doclet, astNode, unresolved[1], unresolved[2]);
        memberof = memberofInfo.memberof;
        scopePunc = memberofInfo.scopePunc;

        if (memberof) {
            doclet.name = doclet.name ?
                memberof + scopePunc + doclet.name :
                memberof;
        }
    }
    else {
        memberofInfo = parser.astnodeToMemberof(astNode);
        basename = memberofInfo.basename;
        memberof = memberofInfo.memberof;
    }

    // if we found a memberof name, apply it to the doclet
    if (memberof) {
        doclet.addTag('memberof', memberof);
        if (basename) {
            doclet.name = (doclet.name || '')
                .replace(new RegExp(`^${escape(basename)}.`), '');
        }
    }
    // otherwise, add the defaults for a module (if we're currently in a module)
    else {
        setModuleScopeMemberOf(parser, doclet);
    }
}

function newSymbolDoclet(parser, docletSrc, e) {
    const newDoclet = createSymbolDoclet(docletSrc, e);