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

Fix incorrect javadoc configuration #21

Merged
merged 1 commit into from
Jan 22, 2025
Merged

Conversation

dwalluck
Copy link
Contributor

No description provided.

@dwalluck
Copy link
Contributor Author

This removes the incorrect <additionalparam> tag (I think you meant <additionalOptions>). This code wasn't necessary anyway since you already have -Xdoclint:none in the global configuration.

So, I just moved the property to the global configuration, but you could remove the use of the property altogether, since building on JDK < 1.8 is not even possible. In which case, we could delete the 1.8+ profile and add back the hardcoded -Xdoclint:none.

@goneall
Copy link
Member

goneall commented Jan 22, 2025

Agree we should get rid of the old historic check for JDK < 1.8 - perhaps we should use the doclint parameter instead. What do you think?

@dwalluck
Copy link
Contributor Author

Agree we should get rid of the old historic check for JDK < 1.8 - perhaps we should use the doclint parameter instead. What do you think?

That's fine. The alternative is to leave it on and (eventually) fix all warnings. It doesn't look like there are that many.

@goneall
Copy link
Member

goneall commented Jan 22, 2025

Agree we should get rid of the old historic check for JDK < 1.8 - perhaps we should use the doclint parameter instead. What do you think?

That's fine. The alternative is to leave it on and (eventually) fix all warnings. It doesn't look like there are that many.

I've been slowly working through removing the warnings. Removing the warnings would be fine as well.

@dwalluck
Copy link
Contributor Author

I've been slowly working through removing the warnings. Removing the warnings would be fine as well.

In that case, I suggest removing all references to doclint in the POM and just let it print the warnings for now. I will update the pull request if you agree.

@dwalluck
Copy link
Contributor Author

@goneall OK, actually, I have added <doclint> which matches how Spdx-Java-Library is now.

Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dwalluck

@goneall goneall merged commit 6235490 into spdx:main Jan 22, 2025
3 checks passed
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.

2 participants