Incorrect longname when exports.foo has a memberof tag
Open
Nobody has claimed this yet.
bugfix
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
In the following example, JSDoc correctly determines that the longname for exports.bar is module:foo.bar:
/** @module foo */
/**
* An exported thing.
*/
exports.bar = {};
However, if you add a @memberof tag, JSDoc sets the name to exports.bar and the longname to module:foo.exports.bar:
/** @module foo */
/**
* An exported thing.
* @memberof module:foo
*/
exports.bar = {};
I haven't checked whether this is a regression.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the two JavaScript examples in the issue and compare the generated name and longname for exports.bar. Trace the handling of @module, exports.bar, and @memberof; done means the second example also resolves to the expected module:foo.bar longname.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100