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

Question

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

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

/** @mixin actions/actions */ 

var actions = module.exports; 

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

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

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

Answer 1

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

/** 
* @mixin 
* @alias actions/actions 
*/ 
var actions = module.exports;