add support for Markdown in comments

[i582]

Hey! This PR adds support for Markdown in doc comments.

Currently it looks like this:

Before

With this changes:

After

Screen.Recording.2024-10-18.at.01.37.20.mov

Please note that this code is taken from my internal language plugin and is well tested.

[mkurnikov]

I didn't know there's an easy way to support Markdown in comments, awesome!

Still, well tested or not, I won't let PR in without tests. Please add one or two.

[i582]

Sure!

[mkurnikov]

Btw, if you want to contribute more, documentation comments support needs some attention. It's broken/unsupported for some language items, and uses old API.
It needs lots of tests, support for the new language items and porting to the DocumentationTarget API.

[i582]

Yep, I have already noticed some problems with the documentation

[i582]

Added several tests for the most commonly used markup constructs

[mkurnikov]

Does the plugin needs to be dependent on the Markdown plugin now?

[i582]

@mkurnikov looks like you need to approve every workflow 😞

[i582]

Does the plugin needs to be dependent on the Markdown plugin now?

it works without it but let me check it for sure

[i582]

This functionality relies on the Markdown plugin, which is bundled and enabled in IntelliJ IDEA by default. If the relevant features are not available, make sure that you did not disable the plugin.
From https://www.jetbrains.com/help/idea/markdown.html

since it's bundled it should work fine I think

[mkurnikov]

looks like you need to approve every workflow

I'll see what I can do. For now, I guess I'd just do it manually.

bundled

Got it, no problem then.

[i582]

Works fine even in IDEA Community

[mkurnikov]

Great work, thanks!

One last bit:
i'm really not a fan of merging the code I don't quite understand, so could you add some docstrings? Link to the SDK documentation on it, or reference to the docstrings in the other parts of the SDK would work too.

[i582]

Great work, thanks!

One last bit: i'm really not a fan of merging the code I don't quite understand, so could you add some docstrings? Link to the SDK documentation on it, or reference to the docstrings in the other parts of the SDK would work too.

Yep

[i582]

@mkurnikov added some documentation, hopefully this code makes a little more sense now