Open isergey opened 9 years ago
You also need a @module
tag at the start of the file, like /** @module mymodulename */
. But it looks like there's also a bug where we use the wrong name for members of the default export. I'll look into this.
For now, you can work around this in one of two ways:
Add an @alias
tag to help JSDoc name each symbol correctly. For example, if your module is named leader
, you would comment Leader.prototype.getData
like so:
/**
* Get leader data
* @alias module:leader#getData
* @return {String} data
*/
Leader.prototype.getData = function() {
return this._data;
};
I am finding that methods of my exported class are not being picked up by jsdoc; I think that this may be related to this issue.
/** @module foo/lib/Environment */
/**
* Represents the environment of a foo project.
*/
export default class Environment {
/**
* Builds output of the foo project that is described by this environment.
*
* @returns {Promise}
* A promise to complete the build.
*/
build() {
return this.behaviors.buildOutput(this);
}
}
Here is the output that I see for the above:
It may just be that I am making a silly mistake; but I seem to be following the advice provided in the ES2015 module section of the documentation.
Many thanks
I don't mean to resurrect an old thread, but I am having an identical issue with identical output to what @kruncher posted. I am however using an anonymous class as my only export. Only my constructor is being documented, no other methods are having their documentation generated.
module.exports = class
Hello! I try to generate documentation for file Leader.js, but in output I found only source description file - Leader.js.html, but Leader.html doesn't exist. What's wrong? Where the Leader.html? Thanks for help!
conf.json
Leader.js