Javadoc tables not rendering properly when following a <br/> tag

[xels034]

Tables aren't correctly displayed when following a <br/> tag. This only happens when they are used after the description block (inside the description of @param, @return, etc.)

Environment

• Operating System: Windows 10
• JDK version: 13.0.1
• Visual Studio Code version: 1.41.0
• Java extension version: 0.54.2

Steps To Reproduce

1. The code below generates Javadoc that shows the issue:

    /**
     * Tables work as expected here: <br/><table><tr><td>One</td><td>Two</td></tr></table>
     * @param param Tables broken here:<br/><table><tr><td>One</td><td>Two</td></tr></table>
     * @return without a line break it's fine: <table><tr><td>One</td><td>Two</td></tr></table>
     * @see this one's broken too: <br/> <table><tr><td>One</td><td>Two</td></tr></table>
     */
    public Object method(Object param){
      return null;
    }

Current Result

For some libraries that can turn really ugly:

Expected Result

Removing the <br/> tag before the tables fixes the display again:

[fbricon]

@NikolasKomonen looks like something for you

[NikolasKomonen]

Found the issue.

This is the test data:

A:


|     |
| --- |
| One |

 *  **Parameters:**
    
     *  param
 *  **See Also:**
    
     *  B:
        

        |     |
        | --- |
        | One |

It seems that (vscode-implemented) Markdown rendering is picky when it comes to indentation/newlines

* B:\n
\n
    |     |
    | --- |
    | One |

The above works because there are 2 '\n' before the table, but the following doesn't work:

* B:\n
\n
\n
    |     |
    | --- |
    | One |

because it has '\n' > 2.

---

Separately, in Eclipse and on Git, the Markdown is rendered properly (even when you have the extra newlines before a table).

So from what I see it is more dependent on the platform rendering it/which Markdown render method they are using.

Testing on: https://dillinger.io/ vs https://stackedit.io/ with the initial markdown worked for one, but not the other.

---

Overall, if you can, don't use <br/>. It is not necessary on Eclipse's HTMLtoMarkdown converter as well as VSCode Java since it automatically puts the table on the next line anyways.

[xels034]

Thanks for the finding, so is this something I should report to the vscode repository? Any chance they would look into that?

Sadly I would need that for a library that I'm using where I'm not in control how they structure their javadocs.

[fbricon]

Looks like it works now: