Using a dot in an event name doesn't work anymore.
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15.5k
- Forks
- 1.5k
- Avg merge
- 10d 23h
- Merged PRs (30d)
- 1
Description
When using a dot . character in an event name, only the last part is shown.
Input code
/**
*/
class Foo {
}
/**
* Test Event
*
* @memberof Foo
* @event one.two
*/
JSDoc configuration
jsdoc .
JSDoc debug output
DEBUG: JSDoc 3.6.7 (Sat, 15 May 2021 01:24:54 GMT)
DEBUG: Environment info: {"env":{"conf":{"plugins":[],"recurseDepth":10,"source":{"includePattern":".+\\.js(doc|x)?$","excludePattern":"(^|\\/|\\\\)_"},"sourceType":"module","tags":{"allowUnknownTags":true,"dictionaries":["jsdoc","closure"]},"templates":{"monospaceLinks":false,"cleverLinks":false,"default":{"outputSourceFiles":true}}},"opts":{"_":["."],"debug":true,"destination":"./out/","encoding":"utf8"}}}
DEBUG: Parsing source files: ["/Users/emile/Desktop/test/test.js"]
Parsing /Users/emile/Desktop/test/test.js ...
DEBUG: Finished parsing source files.
DEBUG: Adding inherited symbols, mixins, and interface implementations...
DEBUG: Adding borrowed doclets...
DEBUG: Post-processing complete.
Generating output files...
Finished running in 0.10 seconds.
Expected behavior
I expected to have an event created one.two.
Current behavior
An event two was created.
Your environment
| Software | Version |
|---|---|
| JSDoc | 3.6.7 |
| Node.js | 16.0.0 |
| npm | 6.14.13 |
| Operating system | macOS 11 |
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
Reproduce the issue with the provided JavaScript doclet and the jsdoc . command, using the debug output to confirm the generated event name. Trace the event-name handling from the @event one.two input and verify that the generated documentation preserves one.two rather than reducing it to two.
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
- 38/100