jsdoc2md / dmd

The default output template for jsdoc2md

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

bracket-related markdown error

boneskull opened this issue · comments

Say you are using the @param tag. Your parameter, name, is optional. It is of type Foo, and Foo is documented elsewhere. dmd generates the following Markdown:

[name] [Foo](#Foo)

Depending on the parser implementation (like this one), this could be a parse error. My recommendation is to generate the following code:

\[name\] [Foo](#Foo)

I have some code that does this that I can send over later, but I wanted to get your opinion before I did. It will avoid parsing issues, however it comes at the expense of human-readability.