Javadoc renderer hint

Darren Bell djb.bell at gmail.com
Wed Feb 28 10:10:54 UTC 2024


I believe it's a great move towards having Markdown supported for javadoc,
but adding the 3 slashes format just seems rather odd.

Lots of editors use a hint to denote how to render the content with code
block tags, e.g.:

```html
<.....
```

Would it not be a good solution for Javadoc as well? We could have a type
after the start of the Javadoc opening tag, e.g.:

/**markdown
 *
 *
 */

This also has the added benefit of being future proof if another format is
introduced later.

--
Darren
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.org/pipermail/javadoc-dev/attachments/20240228/738d8c72/attachment-0001.htm>


More information about the javadoc-dev mailing list