yuidoc - 如何在其他文件中定义类方法

时间:2013-04-05 12:21:48

标签: javascript documentation yuidoc

我正在用yuidoc编写文档。但是,我有一个类Model,它有一个在别处定义的方法。这是一些可视化情况的代码。 假设我有一个文件model.js:

/**
 * @class Model
 * @constructor
 */
 window.Model = function(){}
 ....

文件activerecord.js:

(function(){
    /**
     * @class ActiveRecord
     * @constructor
     window.ActiveRecord = function(){}
     ....
     /**
      * @method Model.hasMany
      * @param {Class} model
      */
     function hasMany(model) {}
})() ;

如您所见,方法'hasMany'应显示在Model的类文档下。但事实并非如此。这样的事情可能吗?

非常感谢

1 个答案:

答案 0 :(得分:2)

请参阅@for代码:http://yui.github.io/yuidoc/syntax/index.html#for

/**  
 * Some method "hasMany" disconnected from its class "Model".
 * 
 * @method hasMany  
 * @for Model
 * @param {Class} model 
 */
function hasMany(model) {}