Документирование класса javascript с прототипами в пространстве имен с помощью jsdoc-toolkit

Я очень стараюсь задокументировать код в формате ниже, используя jsdoc-toolkit. Мне кажется, что используемые мной теги должны дать желаемый результат, но это не так. Вместо этого он предупреждает, что Class недокументирован (потому что он определен только внутри замыкания) и не включает Class в список членов пространства имен.

Я хотел бы задокументировать это, если возможно, не прибегая к использованию тега @name. Может ли кто-нибудь помочь?

/**
 * @namespace The original namespace
 */
var namespace = function () {
    // private
    /**
     * @private
     */
    function _privateMethod () {

    };

    /**
     * This is the detail about the constructor
     * @class This is the detail about the class
     * @param {Object} argone The first argument
     * @param {Object} argtwo The second argument
     */
    var Class = function (argone, argtwo) {
        /**
         * A public member variable
         */
        this.member = "a member";
    };

    /**
     * A public method
     * @param {Object} argone The first argument
     */
    Class.prototype.publicMethod = function (argone) {

    };

    return /** @lends namespace */ {
        Class: Class
    }
}();
10
задан dave 11 April 2011 в 09:14
поделиться