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

[Roberto Castañeda Lozano]

On Tue, 20 May 2025 08:50:22 GMT, Emanuel Peter <epeter at openjdk.org> wrote:

>> test/hotspot/jtreg/compiler/lib/template_framework/Template.java line 197:
>> 
>>> 195:  * <p>
>>> 196:  * More examples for these functionalities can be found in {@link TestTutorial}, {@link TestSimple}, and
>>> 197:  * {@link TestAdvanced}.
>> 
>> These links cannot be resolved by `javadoc` when using the command recommended in the PR description:
>> 
>> $ javadoc -sourcepath test/hotspot/jtreg:./test/lib compiler.lib.template_framework
>> Loading source files for package compiler.lib.template_framework...
>> Constructing Javadoc information...
>> Building index for all the packages and classes...
>> Standard Doclet version 25-internal-2025-05-20-0715327.rocastan.open
>> Building tree for all the packages and classes...
>> test/hotspot/jtreg/compiler/lib/template_framework/Template.java:196: error: reference not found
>>  * More examples for these functionalities can be found in {@link TestTutorial}, {@link TestSimple}, and
>>                                                                   ^
>> test/hotspot/jtreg/compiler/lib/template_framework/Template.java:196: error: reference not found
>>  * More examples for these functionalities can be found in {@link TestTutorial}, {@link TestSimple}, and
>>                                                                                         ^
>> test/hotspot/jtreg/compiler/lib/template_framework/Template.java:197: error: reference not found
>>  * {@link TestAdvanced}.
>>           ^
>> (...)
>
> @robcasloz I saw that as well. But IDE / neovim still thinks its ok. Do you know an alternative that works for `javadoc`?

I guess it is a matter of including `test/hotspot/jtreg/testlibrary_tests/template_framework/examples` into the source path when invoking `javadoc`. But I think it is fine to treat `Test*.java` as external sources and just use `{@code TestTutorial.java}` etc. as you do elsewhere in this file.

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

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