Is it possible to document a javascript plain object using ESDOC?

Question

It seems that ESDOC targets only ES6 class style.

Is there a way to document a plain object like:

/**
 * ???
 */
var Foo = {
    /**
     * ???
     */
    info: true
};

export default Foo;

And even when using ES6 class style, how to document a static property like:

class Bar {
}

/**
 * ???
 */
Bar.info = true;

export default Bar;

score 5 · Answer 1 · answered Jan 24 '17 at 17:54

Short answer. No.

ESDOC is designed specifically to document ES6 classes. It's right in the name. From the FAQ:

ESDoc supports ES2015 and later

If you need to document a mixture of ES6+ and regular (prototypal) classes, JSDOC might be a better bet. It's fairly mature and it's format is a sort of defacto standard.

If you don't like or can't use the main JSDOC package, there are plenty of other options. Just for example, I've had success with jsdoc-to-markdown on my projects. You should be able to find the tools to convert JSDOC to whatever format you need.

fingerpich · Answer 2 · 2017-01-25T23:13:06.177

1

For member and variable you should use @type

/**
* @type {Object}
* @property {boolean} Foo.info describe Foo.info
*/
const Foo = {
   info: true
};

and for static properties in es6 you should use className.method_member

/**
* This is Bar description.
*/
class Bar {
  /**
  * Bar.info
  */
  static info=true
}

check esdoc output here

edited Jan 25 '17 at 23:13

answered Jan 24 '17 at 17:57

fingerpich

8,500
2
22
32

1

This does not work for method properties, they are not generated properly in the documentation – koningdavid Jan 25 '17 at 08:18
for method parameters you should use @param – fingerpich Jan 25 '17 at 10:58
1

I know, but the documentation doesnt generate correctly. It doesnt decribe the function – koningdavid Jan 25 '17 at 12:54
I have added output, is it OK? – fingerpich Jan 28 '17 at 14:05

Is it possible to document a javascript plain object using ESDOC?

2 Answers2