documentationjs / documentationjs/documentation

@deprecated breaks output Markdown

Open
#1,596 1 comment 7 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

When the input JSDoc includes @deprecated tag then line breaks are not working in output markdown.
If input source file is
```
export class Aaa {
/**
* @deprecated
*/
aaaaa() {}
}
```

then it outputs
```
### Table of Contents* [aaaaa][1]## aaaaa**Meta*** **deprecated**: This is deprecated.[1]: #aaaaa
```

without any new line.

On the other hand, if the input doesn't include `@deprecated` then it outputs normally.

* What version of documentation.js are you using?:
14.0.1
* How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):
CLI.
```
npx documentation build -f md --markdown-toc-max-depth 2 --shallow aaa.ts
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.