Инструментарий JsDoc и Пространство имен - Предупреждение пытается .. без - PullRequest
0 голосов
/ 11 сентября 2011

Я использую jsdoc-toolkit с библиотекой пространства имен Mike Koss .Код выглядит следующим образом

namespace.module('a.b', // this is the namespace

// @param {Object} exports visible classes within this namespace
// @param {function} required other namespaces
function (exports, require) {

var entityBase = require("a.base");
var util = require("a.util");

// @class BlaBla
// @constructor
// @property {String} ..
// @property {String} ..
// @property {String} ..
// @property {..} ....
// @param {Array} ...
// @param {X} [optionalParam]
exports.MyClass = function (...) {

Создание документации Я получаю следующее сообщение , и для этого класса вообще не создается документация .

>> WARNING: Trying to document exports.MyClass without first documenting exports.

Я пыталсяпреодолеть проблему с помощью строки параметров - безуспешно.

// @param {Object} exports visible classes within this namespace
// @param {function} required other namespaces
function (exports, require) {

Есть идеи, как решить проблему?

1 Ответ

2 голосов
/ 14 сентября 2011

Я переключился на JsDoc 3 (https://github.com/micmath/jsdoc#readme).). Это модули поддержки и, следовательно, вышеуказанная библиотека пространства имен.

...