Jak mogę udokumentować AMD projekt + szkieletowej z JSDoc3

Question

Mam projekt Backbone boilerplate opartego, że chcę, aby dokument z niedawnym jdoc-toolkit

Chociaż nie mogę zmusić go do wygenerowania niczego poza pustym _global klasy

przykładowy kod:

/** 
* This is a root model for DLClass 
* @module models/DLClass 
*/ 
define([ 
    'underscore', 
    'backbone' 
], /** @lends DLClass */ function (_, Backbone) {   
    /** 
    * This is a root model for DLClass 
    * @class DLClass 
    * @constructor 
    * @return Session Object 
    */ 
    var DLModel = Backbone.Model.extend({ 
     /** @lends DLClass.prototype */ 

    /** 
    * Generic tap event 
    * @param touchEvent 
    */ 
    onTap: function (touchEvent) { 

    }, 

Answer 1

spróbuj dodać @namespace pozwolić JSDoc wiedzieć, aby przejrzeć zawartość modułu. I zdefiniuj swój moduł i jego funkcje za pomocą @name.

/** 
* This is a root model for DLClass 
* @module models/DLClass 
* @namespace 
*/ 
define([ 
    'underscore', 
    'backbone' 
], /** @lends DLClass */ function (_, Backbone) {   
    /** 
    * This is a root model for DLClass 
    * @class DLClass 
    * @module models/DLClass 
    * @name DLClass 
    * @constructor 
    * @return Session Object 
    */ 
    var DLModel = Backbone.Model.extend({ 
     /** @lends DLClass.prototype */ 

     /** 
     * Generic tap event 
     * @name DLClass.onTap 
     * @function 
     * @param touchEvent 
     */ 
     onTap: function (touchEvent) { 

     },