RFR: Fix javadoc generation and add check to testing suite

Jorn Vernee jvernee at openjdk.org
Thu Mar 28 03:08:42 UTC 2024


On Thu, 28 Mar 2024 01:23:47 GMT, James Yuzawa <duke at openjdk.org> wrote:

> Motivation: There is bad javadoc being generated. This fixes that and also adds a check to the testing suite to make sure it does not happen again.
> 
> Notes: I branched off of jdk22 branch since I would like such fixes to make their way into the jdk22 branch. Please let me know if there is a different base or head I should use.

Hey, thanks for the fix! Great idea to add a call to javadoc to the tests as well.

This should be targeted at the `master` branch though, as that is the latest version of jextract targeting Java 22 (the jdk22 branch was used before Java 22 was released, but it is currently outdated).

test/lib/testlib/TestUtils.java line 89:

> 87:             System.err.println("javadoc sources @ " + sourcePath.toAbsolutePath());
> 88:             List<String> commands = new ArrayList<>();
> 89:             commands.addAll(files);

I suggest disabling `missing` doclint warnings here, since we have a lot of those, and they drown out the actual errors when javadoc fails.
Suggestion:

            commands.add("-Xdoclint:all,-missing");
            commands.addAll(files);

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

PR Review: https://git.openjdk.org/jextract/pull/227#pullrequestreview-1965083097
PR Review Comment: https://git.openjdk.org/jextract/pull/227#discussion_r1542252631


More information about the jextract-dev mailing list