Documenting a javascript class with prototypes in a namespace using jsdoc-toolkit

Question

I'm trying very hard to document code in the format below using jsdoc-toolkit. It looks to me like the tags I've used should produce the desired result but it doesn't. Instead it warns that Class is undocumented (because it is only defined inside the closure) and doesn't include Class in list of members of namespace.

I'm would like to document this without resorting to using the @name tag if possible. Can anyone help?

/**
 * @namespace The original namespace
 */
var namespace = function () {
    // private
    /**
     * @private
     */
    function _privateMethod () {

    };

    /**
     * This is the detail about the constructor
     * @class This is the detail about the class
     * @param {Object} argone The first argument
     * @param {Object} argtwo The second argument
     */
    var Class = function (argone, argtwo) {
        /**
         * A public member variable
         */
        this.member = "a member";
    };

    /**
     * A public method
     * @param {Object} argone The first argument
     */
    Class.prototype.publicMethod = function (argone) {

    };

    return /** @lends namespace */ {
        Class: Class
    }
}();

what version of JSDoc Toolkit are you using to generate the docs? — Stephen, Dec 31 '12 at 06:13

score 4 · Answer 1 · answered Jan 08 '13 at 05:08

I tried a bunch of different things and this was the best I could come up with.

The first part...documenting the publicMethod on Class. First make Class a memberOf namespace and then use @lends on the Class.prototype. Example:

/**
 * @namespace The original namespace
 */
var namespace = function () {
    // private
    /**
     * @private
     */
    function _privateMethod () {

    };

    /**
     * This is the detail about the constructor
     * @class This is the detail about the class
     * @memberOf namespace
     * @param {Object} argone The first argument
     * @param {Object} argtwo The second argument
     */
    var Class = function (argone, argtwo) {
        /**
         * A public member variable
         */
        this.member = "a member";
    };

    Class.prototype = 
    /** @lends namespace.Class */ 
    {
        /** a public method
          * @param {Object} argone The first argument
        */
        publicMethod: function (argone) {

        }
    };

    return {
        Class: Class
    }
}();

Now, the second part...getting Class to show up as on the namespace. I'm not sure how to do that...sorry! It will show up as namespace.Class in the class index.

score 0 · Answer 2 · answered Feb 05 '13 at 22:04

0

Just as a tip: jsdoc 2 is full of bugs and bad practices.
Consider trying JSDOC3 -> https://github.com/jsdoc3/jsdoc or no jsdoc at all depending the nature of the project.

answered Feb 05 '13 at 22:04

Fagner Brack

2,365
4
33
69

2

JSDoc 3 isn't working either. The whole tool is somewhat ridiculous. – Thomas Urban Jun 13 '16 at 14:20
I'm using jsdoc3 via npm and it's ignoring prototypes as well. – Jake Wilson Oct 20 '16 at 06:21

Documenting a javascript class with prototypes in a namespace using jsdoc-toolkit

2 Answers2