How do I document AMD + Backbone project with JSDoc3

前端 未结 1 1247
清酒与你
清酒与你 2020-12-19 06:39

I have a Backbone boilerplate based project, that I want to document with recent jdoc-toolkit

Though I can\'t get it to generate anything but empty _global class

相关标签:
1条回答
  • 2020-12-19 07:10

    Try adding the @namespace to let JSDoc know to look through the contents of the module. And define your module and it's functions using @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) {
    
            },
    
    0 讨论(0)
提交回复
热议问题