Closed
Description
Currently there is an issue with inferring membership from es6 class for its method.
Method become a part of globally defined class instead of class that is defined inside own module.
So method the method that is BigFeature.MyClass#method
become MyClass#method
and documentation is not readable for such cases. To resolve it I should manually write @memberof BigFeature.MyClass
for every method.
Expected behavior is proper inferring for such cases to prevent writing extra comments.
- What version of documentation.js are you using?: 8.1.0
- How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):
npx documentation build example.js -f md
Input:
/**
* My big feature.
*
* @module BigFeature
*/
/**
* My class.
*
* @memberof BigFeature
*/
class MyClass {
/** My method */
method() {
return {};
}
}
Current output (for md):
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
- [BigFeature][1]
- [MyClass][2]
- [method][3]
## BigFeature
My big feature.
### MyClass
My class.
## method
My method
[1]: #bigfeature
[2]: #myclass
[3]: #method
Expected output:
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
### Table of Contents
- [BigFeature][1]
- [MyClass][2]
- [method][3]
## BigFeature
My big feature.
### MyClass
My class.
#### method
My method
[1]: #bigfeature
[2]: #myclass
[3]: #method
Metadata
Metadata
Assignees
Labels
No labels