RFR: JDK-8298405: Support Markdown in Documentation Comments [v7]

Pavel Rappo prappo at openjdk.org
Mon Feb 12 15:47:08 UTC 2024


On Wed, 31 Jan 2024 22:15:23 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> I guess I don't see this as being as big a deal as you seem to think it is. What is it that you are so concerned about?
>> 
>> I also think it is a potential feature to document and use reference links with `code:` URLs, using the reference link syntax to avoid having long method signatures in narrative text.
>> 
>> For example, 
>> 
>>    One of the methods on [List] has [lots of args][List.of10].
>>    
>>    [List.of10]code:List.of(E,E,E,E,E,E,E,E,E,E)
>
> I've changed the prefix to be dynamically generated. It's now called `autorefScheme` and is passed around as needed. It contains a hex hashcode, so is reasonably unguessable.
> 
> I'm still sort-of sad to lose the ability to use `code:` URLs directly, so I've left a comment in the code hinting that that is a possibility.

Thanks for accepting this; we could revert it later if the fixed, known scheme is deemed more useful.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/16388#discussion_r1486364459


More information about the build-dev mailing list