Treat constructor method as proper constructor of an object

[lrowe]

With this minimal class:

/** */
class Foo {
  /** */
  constructor(bar) {
    this.bar = bar;
  }
}

Runningnode_modules/.bin/documentation serve doc.js produces the following output with 4.0.0-beta.18:

I would expect the constructor not to be displayed as an instance method and it's parameters included in the instantiation example.

[leonpegg]

This is exactly what i would of expected as well also if the constructor is not defined but class is extended should pull in the def from the parent class

[paulofaria]

yeah I'm getting the same issue. is there something we should be doing that we aren't?

[tmcw]

This is a known issue - so far documentation doesn't do any special treatment of constructor methods versus any other methods, and it should.

[leonpegg]

I have been working on my own theme that does additional processing of the json i will release the theme once completed, but I believe this additional processing should be done befre the theme stage

[tmcw]

Q:

Should you document a class like:

/**
  * I describe the class here, and use param tags here
  */
class Foo {
  /** */
  constructor(bar) {
    this.bar = bar;
  }
}

Or

/** */
class Foo {
  /**
    * I describe the class here, and use param tags here
    */
  constructor(bar) {
    this.bar = bar;
  }
}

I'm leaning toward the former, and trying an implementation now.

[tmcw]

Okay: I have a working branch that does the following:

• In parameter inference, when it encounters an ES6 class, it looks at the class's members and, if it finds a constructor, infers parameters from that constructor.
• Warns if a constructor is explicitly documented.

[arv]

I would have preferred to document the parameters on the constructor. Putting it on the class is just more out of bounds and more likely to get out of sync.

(But personally I do not document parameters and just let the inference do it's work.)