Как документировать подпространство имен с помощью JSDoc при использовании шаблона модуля

Я пытаюсь документировать функции внутри определенного шаблона модуля с помощью jsdoc-toolkit, где пространство имен определяется вне модуля. Функции, которые к нему присоединяются, находятся внутри непосредственно вызывающей функции. Что я получаю от вывода инструмента:

ВНИМАНИЕ: попытка задокументировать isObject как элемент недокументированного символа CORE.

Вот упрощенная версия кода:

/**
 * @namespace The framework's top namespace
 * */
var FX = {
  /**
   * @namespace The core framework functions
   */
  core: {
  }
};

(function( CORE, GLOBAL ) {

    'use strict';

    var _isObject;

    CORE.isObject = _isObject = function( object ) {

        if (null === object || (void 0) === object) {
            return false
        }

        return true;

    };

    return CORE;

})(this.FX.core, this);

javascript jsdoc
person Azder    schedule 29.06.2012    source источник

Ответы (1)


arrow_upward
2
arrow_downward

Вы можете попробовать тег @memberOf, который позволяет документировать то, что вы считаете "родителем" или контейнером объекта.

/** 
 * @memberOf FX.core 
 */
CORE.isObject = _isObject = function( object ) {
    // ...
};
// ...

Синтаксис: @memberOf parentNamepath, parentNamepath — путь имени содержащего объекта.

person wiky    schedule 29.06.2012
comment
Я уже разобрался с этим, все еще жду, есть ли какое-то другое решение - person Azder; 29.06.2012
comment
Принимаю, потому что это только ответ и, вероятно, поможет кому-то в подобной ситуации. - person Azder; 24.01.2014