Local var definition and exports in RequireJS module

[danrzeppa]

Sometimes in RequireJS modules I define a local variable in the same statement that exports a function. This appears to confuse JSDoc as it does not recognize the exported symbol as being exported.

File1

/** @exports file1 */
define(function(){
  var exports={}

  /** @constructor */
  var someObject = exports.someObject = function() {}
  someObject.prototype.whatever=function() {}

  return exports
})

JSDoc cannot resolve the reference to module:file1.someObject in the @augments tag in

File 2

/** @exports file2 */
define(function(){
  var exports = {}
  var file1 = require("./file1")

  /**
  * @constructor
  * @augments module:file1.someObject
  */
  exports.otherObject = function() {}

  return exports
})

This is not a critical, or truly breaking issue since the same thing can be accomplished via

  /** @constructor */
  exports.someObject = function() {}
  var someObject = exports.someObject

But it would be nice if at some point it was supported.

[micmath]

Another way to do it is

var someObject =
/**
    @constructor
*/
exports.someObject = function() {
}

But in general the doc comment must appear immediately before the thing it documents (unless you provide a @name and then it can appear anywhere you please).

[jannon]

This might be a good candidate for a plugin. I'll try to look into the possibilities. For now, it's going into the 'future' bucket

[micmath]

I'm closing this since there is already two ways to do what the poster asks: use @name or split the assignment on two lines so the comment appears immediately before the thing being documented. This is already working as designed.