documentationjs / documentationjs/documentation

Improve Support for @memberof inference with ES6 modules

Open
#488 1 comment 5 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

A common pattern in modern js web development is to have several named utility modules with named and default exports.

It would be ideal if `documentation.js` was smart enough to infer the membership status of private and exported methods that were documented inside the module.

I've set up a demonstration to illustrate what I'm after here:

https://github.com/ajhyndman/documentation-js-demo/commit/9ef86935e7682fb0d3217c534c53b1a86a49c086

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.