documentationjs / documentationjs/documentation

Treat constructor method as proper constructor of an object

Open
#689 12 comments 3 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

With this minimal class:
```js
/** */
class Foo {
/** */
constructor(bar) {
this.bar = bar;
}
}
```

Running`node_modules/.bin/documentation serve doc.js` produces the following output with 4.0.0-beta.18:
![image](https://cloud.githubusercontent.com/assets/290859/23647335/34aeb2f0-02ca-11e7-81ff-e62aa6a3adf9.png)

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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.