How do I document AMD + Backbone project with JSDoc3
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
Code sample:
/**
* 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) {
},
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) {
},