hegemonic / jsdoc-baseline

An experimental, extensible template for JSDoc.
Other
61 stars 32 forks source link

Duplicated headline #164

Closed SunboX closed 9 years ago

SunboX commented 9 years ago

The headline new Registration() is duplicated in this case.

Sample

/**
 * Text
 *
 * @class
 * @memberof xxx
 */
xxx.Registration = (function() {

    /**
     * @constructs xxx.Registration
     */
    var Registration = function() {};

    return Registration;

})();

Gnerated docs

headline

hegemonic commented 9 years ago

This is the expected behavior--the same thing happens with JSDoc's default template. The issue is that you've effectively documented the constructor twice.

You can solve this issue by documenting the constructor just once:

xxx.Registration = (function() {

    /**
     * Text
     *
     * @class
     * @memberof xxx
     */
    var Registration = function() {};

    return Registration;

})();
SunboX commented 9 years ago

Thanks for the hint! :smile: