`@member` doesn't work
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
/**
*/
const SomeObject = {
/** @member */
someMember: 0
}
Expected: Documentation for SomeObject lists someMember as a member.
Actual: Documentation for SomeObject lists no members.
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 running JSDoc on the minimal JavaScript example from the issue and inspect how the generated documentation represents SomeObject. Trace the handling of the @member annotation and verify that the completed behavior lists someMember as a member.
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
- Clearly specified
- Newbie friendliness
- 48/100