Document jsdoc
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
- The
Sorterclass in /jsdoc/lib/jsdoc/augment.js - The
Docletclass in /jsdoc/lib/jsdoc/src/parser.js - The
AstBuilderclass in /jsdoc-parse/lib/ast-builder.js - The
Walkerclass in /jsdoc/src/walker.js
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 reviewing the existing documentation patterns in the listed files: packages/jsdoc/lib/jsdoc/augment.js for Sorter, packages/jsdoc/lib/jsdoc/src/parser.js for Doclet, packages/jsdoc-parse/lib/ast-builder.js for AstBuilder, and jsdoc/src/walker.js for Walker. Document each class and confirm that all four requested classes have clear JSDoc coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100