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 Javadoc Plugin Configuration #418

Merged
merged 1 commit into from
Nov 21, 2024

Conversation

dariuszzbyrad
Copy link
Collaborator

This PR updates the Maven Javadoc Plugin configuration in the pom.xml to address issues with Javadoc generation and improve build stability.

Key Changes

  1. Removed unnecessary module options:

    • Removed --add-modules and ALL-MODULE-PATH from additionalJOption, as they were not required and could cause issues in modular projects.
  2. Added -Xdoclint:none option:

    • Suppresses all Javadoc lint warnings, such as missing @param descriptions, to streamline the build process.

Benefits

  • Simplifies and fixes the Javadoc Plugin configuration.
  • Avoids unnecessary warnings or errors during Javadoc generation.
  • Makes the configuration compatible with both modular and non-modular projects.

@FDelporte
Copy link
Member

Thanks @dariuszzbyrad for investigating this further and your very clear and detailed descriptions!!!

@FDelporte FDelporte merged commit 1d20bc3 into Pi4J:develop Nov 21, 2024
1 check 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