@borrows

Содержание

• Синтаксис
• Обзор
• Примеры

Синтаксис

@borrows <that namepath> as <this namepath>

Обзор

Тег @borrows позволяет добавить документацию на другой символ в вашу документацию.

Этот тег будет полезен, если у вас есть более одного способа ссылки на функцию, но вы не хотите дублировать ту же документацию в двух местах.

Примеры

В этом примере есть документация для функции "trstr", но "util.trim" — это просто ссылка на ту же функцию с другим именем.

/**
 * @namespace
 * @borrows trstr as trim
 */
var util = {
    trim: trstr
};

/**
 * Remove whitespace from around a string.
 * @param {string} str
 */
function trstr(str) {
}