Support doxygen @brief notation
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
Please support the @brief notation, for a more seamless experience integrating Doxygen-style documentation with jsdoc.
In particular, just catch and silently ignore this directive altogether (!)
When I make the mistake of copying @brief... into my jsdoc comments, then jsdoc ends up mistakenly deleting the entire sentence from the resulting HTML files, which is not what I want to happen.
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
No file or test is named in the issue. Start by locating JSDoc's handling of directives in comments, then check the generated HTML for a comment containing @brief; done means the directive is ignored and the sentence after it remains in the output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100