documentationjs / documentationjs/documentation

Namespace exports not working.

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

Description

Documenting the export of a namespace doesn't appear to be working.
In this case we want to specifically document an external object without documenting its internals.

Example:
```
/**
* Documentation for the thing
*/
export {default as something} from "./something.js";
```

There is a workaround explained here: https://github.com/documentationjs/documentation/issues/1238#issuecomment-797420898

Documenting a `let` works but not when exporting the object directly.

What version of documentation.js are you using?: 13.1.1
How are you running documentation.js (on the CLI, Node.js API, Grunt, other?): CLI

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.