A long, long time ago, I implemented documentation comments for my custom language. It’s all been working well, but now I’ve had a user report that they’re not rendering reliably when files in that language are opened into editor tabs with Render All Doc Comments enabled, though they do render if you toggle that open off and back on, or if you explicitly request a particular doc comment to be rendered.
I’m able to reproduce that successfully in even the simplest of scenarios. Here’s a demo:
I can see, however, that my implemementation of DocumentationProvider#getRenderedDoc() is returning the rendered text just fine for all doc comments, so it doesn’t seem to be an issue with something like a ProcessCanceledException being thrown during rendering or similar.
Here are the breakpoints for the class and method header docs having been rendered successfully and handed off to the IDE:
I can then step out until I can see DocRenderPassFactory#doCollectInformation() set its items to what seems to be a valid value for doc comment rendering:
Any idea where to go next to understand why these doc comments aren’t rendering properly in the actual editor? It certainly seems that I’m doing everything required, and this is something that worked properly in earlier IDE versions, though I haven’t tried to isolate the exact version in which the behavior changed/broke…at least not yet.