RFR: 8344942: Template-Based Testing Framework [v2]

[Emanuel Peter]

On Mon, 31 Mar 2025 11:04:07 GMT, Emanuel Peter <epeter at openjdk.org> wrote:

>> test/hotspot/jtreg/compiler/lib/template_framework/Template.java line 41:
>> 
>>> 39:  * the {@link Template}s provide <strong>hashtag replacements</strong> in the Strings: the {@link Template} argument
>>> 40:  * names are captured, and the argument values automatically replace any {@code "#name"} in the Strings. See the
>>> 41:  * different overloads of {@link make} for examples. Additional hashtag replacements can be defined with {@link let}.
>> 
>> General Javadocs comment: You should preceed method names with `#` in order to create a proper link.
>> 
>> Without:
>> ![image](https://github.com/user-attachments/assets/b53280a4-8d5a-40a6-84a6-07fc78aa0c2d)
>> 
>> With (i.e. `{@link make}` and `{@link #let})`:
>> ![image](https://github.com/user-attachments/assets/1722614d-9535-410f-b2de-494ecd45a42a)
>
> interesting. As we saw offline, `javadoc` does not need the hashtag, but some editors do, and it seems to be common practice to have the hashtag. I'll add them for every applicable link.

I think I fixed all, but I cannot easily confirm. Can you check if there are any left?

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

PR Review Comment: https://git.openjdk.org/jdk/pull/24217#discussion_r2020862929