Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Attempt to fix javadoc generation warning/fail #520

Closed
wants to merge 1 commit into from

Conversation

slachiewicz
Copy link
Member

It looks like the links section is problematic Adding a reference to Javadocs 21 generates the warning/fail.

@sebbASF
Copy link
Contributor

sebbASF commented Jan 19, 2025

What is the problem you are seeing?
Are you referring to the following:

Warning: Javadoc Warnings
Warning: [WARNING] warning: The code being documented uses packages in the unnamed module, but the packages defined in https://docs.oracle.com/en/java/javase/21/docs/api/ are in named modules.
Warning: [WARNING] 1 warning

@sebbASF
Copy link
Contributor

sebbASF commented Jan 20, 2025

This PR overrides the setting in the parent pom, so I think any changes need to be made there if possible. We don't want to have to add this fix to every component.

@sebbASF sebbASF marked this pull request as draft January 20, 2025 10:15
@garydgregory
Copy link
Member

garydgregory commented Jan 20, 2025

I'm not sure that's the solution anyway. The problem is that Javadoc doesn't know about the module name, so we probably need to point it to the module we generate at build time.

./target/moditect/generated-sources/org.apache.commons.csv/module-info.java
./target/moditect/org.apache.commons.csv/versions/9/module-info.java

I wonder if we might be stuck with this warning until we bump to Java 9+ because if I edit the Jaavdoc plugin config in the parent POM to point it to the generated module using sourcepath, then Javadoc errors out because we also use source set to 8.

@sebbASF
Copy link
Contributor

sebbASF commented Jan 20, 2025

It did fix the warning for me

@garydgregory
Copy link
Member

garydgregory commented Jan 20, 2025

But do you have links to everything like the JDK classes?

@sebbASF
Copy link
Contributor

sebbASF commented Jan 20, 2025

What links are you referring to?

@garydgregory
Copy link
Member

Closing: This is now fixed in the parent POM. TY both 👍

@slachiewicz slachiewicz deleted the javadoc8 branch January 21, 2025 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants