Jsdoc3 commenting object

Question

Assuming I have some object, what the is way to comment it using jsdoc3?

/**
 * Test object
 * @namespace test
 */
var test = {
    /**
     * Some defaults
     * @memberOf test
     */
    defaults: {
      'test1': 1,
      'test2': 2
    },
    /**
     * Somthing else
     * @memberOf test
     */
    deep: {
      /**
       * Some option
       * @memberOf {test.deep}
       */
      option: {},
      /**
       * Some method
       * @memberOf test.deep
       */
      method: {},
      /**
       * Some option
       * @memberOf {test.deep.evenMore}
       */
      evenMore: {
        /**
         * Some option
         * @memberOf test.deep.evenMore
         */
        test: false
      }
    }
};

But jsdoc creates documentation only for Namespace: test and members deep, defaults

Namespace: test test Test object

Members

deep Somthing else

defaults Some defaults

test.deep should also be a namespace I believe, if you want the Member of to show up. — Scottux, Feb 25 '14 at 19:45
I'm not an expert in javascript, but maybe exist a better way for doing things like this, maybe prototiping? — rpax, Feb 27 '14 at 14:58

score 1 · Answer 1 · answered Feb 26 '14 at 19:50

As @Scottux said, the only way to archieve this is naming additional namespaces.

/**
 * Test object
 * @namespace test
 */
var test = {
    /**
     * Some defaults
     * @memberOf test
     */
    defaults: {
      'test1': 1,
      'test2': 2
    },
    /**
     * Somthing else
     * @memberOf test
     * @namespace test.deep
     */
    deep: {
      /**
       * Some option
       * @memberOf test.deep
       */
      option: {},
      /**
       * Some method
       * @memberOf test.deep
       */
      method: {},
      /**
       * Some option
       * @memberOf test.deep
       * @namespace test.deep.evenMore
       */
      evenMore: {
        /**
         * Some option
         * @memberOf test.deep.evenMore
         */
        test: false
      }
    }
};

The generated documentation will look like this:

Generated documentation screenshot

Jsdoc3 commenting object

1 Answers1