documentation icon indicating copy to clipboard operation
documentation copied to clipboard

@deprecated breaks output Markdown

Open ingun37 opened this issue 1 year ago • 0 comments

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

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->### 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

ingun37 avatar May 19 '23 09:05 ingun37