@borrows

Syntax

@borrows otherMemberName as thisMemberName

Overview

@borrows copies the documentation from another symbol. Use it when a symbol is an alias or re-export of another and you want to avoid duplicating the comment.

Example

/**
 * @namespace
 */
var Utils = {};

/**
 * Joins path segments together.
 * @param {...string} parts
 * @returns {string}
 */
function joinPath(...parts) {
  return parts.join('/');
}

/**
 * @borrows joinPath as Utils.joinPath
 */
Utils.joinPath = joinPath;

See also

• @alias
• @see

Official reference: jsdoc.app/tags-borrows