3

node.js モジュールを yuidoc ( http://yui.github.io/yuidoc/ ) で文書化しようとしていますが、パラメーターからその実装へのリンクを作成する方法を考えています。

私が次のものを持っているとしましょう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;

yuidoc に html ドキュメントで正しいハイパーリンクを生成させるために、Routes関数がオブジェクトを引数に取るようにするにはどうすればよいですか? Repo(上記のスニペットは機能していないようです)

4

1 に答える 1

1

@constructorだから、タグを追加するのは簡単です！このような：

/**
 * Routes
 * @class Routes
 * @constructor
 * @module routing
 * @param {Repo} repo - the repo object
 */
var Routes = function(repo) {
}
modules.exports = Routes;
于 2013-04-30T08:48:29.320 に答える