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

Emanuel Peter epeter at openjdk.org
Mon Mar 31 11:08:05 UTC 2025


On Mon, 31 Mar 2025 08:18:59 GMT, Christian Hagedorn <chagedorn at openjdk.org> wrote:

>> Emanuel Peter has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains six additional commits since the last revision:
>> 
>>  - Merge branch 'master' into JDK-8344942-TemplateFramework-v3
>>  - fix tests
>>  - whitespace
>>  - whitespace
>>  - fix whitespace
>>  - JDK-8344942
>
> 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.

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

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


More information about the hotspot-compiler-dev mailing list