Skip to content

@deprecated breaks output Markdown #1596

@ingun37

Description

@ingun37

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions