Duplicate error message
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
I have a file Person.js with the content:
/**
* @private
* This is a private Person
*/
function Person() {
}
Running jsdoc using node:
node jsdoc.js Person.js
ERROR: The @private tag does not permit a value. File: Person.js, line: 1
ERROR: The @private tag does not permit a value. File: Person.js, line: 5
I get duplicate error messages for the same error, first for the comment, parser.on('jsdocCommentFound', ...), and the second for the symbol, parser.on('symbolFound', ...).
Cheers,
Jonas
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 with the Person.js example and run the documented node jsdoc.js Person.js command to reproduce the duplicate messages. Trace the parser.on('jsdocCommentFound', ...) and parser.on('symbolFound', ...) handlers mentioned in the report; done means the single invalid @private usage produces only one error.
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
- 35/100