Yuidoc :指定参数的性质

Question

我正在尝试用yuidoc (http://yui.github.io/yuidoc/)记录我的node.js模块，我想知道如何创建一个从参数到它的实现的链接。

假设我有以下src/core/Repo.js

/**
 * Repo
 * @class Repo
 * @module core
 */
var Repo = function() {
  /**
   * Insert stuff
   * @param {Object} obj - some stuff
   * @param {Function} callback - error/success callback
   */
  var _insert() = function(obj, callback) {
  }
  return {
    insert : _insert
  }
}
module.exports = Repo;

和一个src/routing/Routes.js

/**
 * Routes
 * @class Routes
 * @module routing
 * @param {Repo} repo - the repo object (from repo.js)
 */
var Routes = function(repo) {
}
modules.exports = Routes;

为了让Routes在html文档中生成正确的超链接，我该如何告诉yuidoc函数接受一个Repo对象？(上面的代码片段似乎不起作用)

Answer 1

所以，添加@constructor标签很简单！如下所示：

/**
 * Routes
 * @class Routes
 * @constructor
 * @module routing
 * @param {Repo} repo - the repo object
 */
var Routes = function(repo) {
}
modules.exports = Routes;