Объявите модуль CommonJs как миксин (JsDoc)

У меня есть несколько автономных модулей, которые просто миксины, используемые классами.

В принципе, мой синтаксис именно такой:

/** @mixin actions/actions */

var actions = module.exports;

/**
 * Some method
 */
actions.foo = function () {};

Файл определяется как миксин, но в описании API к нему не привязан метод.

Я использую JsDoc 3.3 и не могу понять, почему это не работает.


javascript jsdoc jsdoc3
person Simon Boudrias    schedule 06.01.2014    source источник

Ответы (1)


arrow_upward
0
arrow_downward

Я нашел решение, которое работает для меня. Присвоение имени @mixin было проблемой, так как символ не распознавался на странице. Что вам нужно сделать, так это @alias при необходимости (или сохранить имя переменной).

/**
 * @mixin
 * @alias actions/actions
 */
var actions = module.exports;
person Simon Boudrias    schedule 20.01.2014