JsDoc toolkit and Namespace - Warning trying to .. without

非 Y 不嫁゛ 提交于 2019-12-12 04:31:45

问题


I am using jsdoc-toolkit with the namespace library of Mike Koss. The code looks like this

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 (...) {

Creating documentation I get the following message and no documentation is created at all for this class.

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

I have tried to overcome the issue with the param lines - no success.

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

Any idea how to overcome the issue?


回答1:


I have switched to JsDoc 3 (https://github.com/micmath/jsdoc#readme). This support modules and hence the above namespace library.



来源:https://stackoverflow.com/questions/7379775/jsdoc-toolkit-and-namespace-warning-trying-to-without

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!