2013-04-30 2 views
3

Я пытаюсь задокументировать мои модули node.js с помощью yuidoc (http://yui.github.io/yuidoc/), и мне интересно, как создать ссылку из param для ее реализации.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; 

Как сказать функция Routes принимает парам на Repo объект для того, чтобы иметь yuidoc генерировать правильную гиперссылку в html-документах? (Отрывок сверху не работает)

ответ

1

Итак, это просто, как добавление тега @constructor! Пример:

/** 
* Routes 
* @class Routes 
* @constructor 
* @module routing 
* @param {Repo} repo - the repo object 
*/ 
var Routes = function(repo) { 
} 
modules.exports = Routes; 
Смежные вопросы