Skip to content

Enable Javadoc doclint errors#2799

Merged
riccardobl merged 1 commit into
jMonkeyEngine:masterfrom
8Keep:javadoc-doclint-errors
May 28, 2026
Merged

Enable Javadoc doclint errors#2799
riccardobl merged 1 commit into
jMonkeyEngine:masterfrom
8Keep:javadoc-doclint-errors

Conversation

@8Keep
Copy link
Copy Markdown
Contributor

@8Keep 8Keep commented May 23, 2026

Summary

  • fail Javadoc tasks on doclint errors by removing the global doclint suppression and failOnError override
  • remove module-local doclint suppressions for terrain, lwjgl3, and saferallocator
  • fix the doclint errors exposed in core Javadocs and exclude generated libjglios native-image glue from iOS examples Javadocs

@github-actions
Copy link
Copy Markdown

🖼️ Screenshot tests have failed.

The purpose of these tests is to ensure that changes introduced in this PR don't break visual features. They are visual unit tests.

📄 Where to find the report:

⚠️ If you didn't expect to change anything visual:
Fix your changes so the screenshot tests pass.

If you did mean to change things:
Review the replacement images in jme3-screenshot-tests/build/changed-images to make sure they really are improvements and then replace and commit the replacement images at jme3-screenshot-tests/src/test/resources.

If you are creating entirely new tests:
Find the new images in jme3-screenshot-tests/build/changed-images and commit the new images at jme3-screenshot-tests/src/test/resources.

Note; it is very important that the committed reference images are created on the build pipeline, locally created images are not reliable. Similarly tests will fail locally but you can look at the report to check they are "visually similar".

See https://github.com/jMonkeyEngine/jmonkeyengine/blob/master/jme3-screenshot-tests/README.md for more information

Contact @richardTingle (aka richtea) for guidance if required

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request focuses on improving Javadoc quality and consistency across the project. Key changes include fixing malformed HTML tags, updating parameter descriptions to match method signatures, and removing Javadoc error suppression in Gradle build files to enforce stricter documentation standards. A review comment identifies a grammatical improvement in BlendSpace.java, suggesting the use of "between" instead of "among" when referring to exactly two actions.

Comment thread jme3-core/src/main/java/com/jme3/anim/tween/action/BlendSpace.java
@8Keep 8Keep force-pushed the javadoc-doclint-errors branch 2 times, most recently from b6f51ca to d1e7c04 Compare May 27, 2026 00:03
@8Keep 8Keep marked this pull request as ready for review May 27, 2026 00:06
@8Keep
Copy link
Copy Markdown
Contributor Author

8Keep commented May 27, 2026

Rebased + now ready for review

@8Keep 8Keep force-pushed the javadoc-doclint-errors branch from d1e7c04 to 89a9dab Compare May 27, 2026 18:35
@8Keep
Copy link
Copy Markdown
Contributor Author

8Keep commented May 27, 2026

This one should be good @riccardobl but I believe there's an issue with the build recently with your ios changes

@riccardobl
Copy link
Copy Markdown
Member

Thanks!

@riccardobl riccardobl merged commit 5f6eca8 into jMonkeyEngine:master May 28, 2026
9 of 10 checks passed
riccardobl added a commit that referenced this pull request May 28, 2026
@riccardobl
Copy link
Copy Markdown
Member

Reverted this for now, because it was causing the build to fail due to javadoc errors https://github.com/jMonkeyEngine/jmonkeyengine/actions/runs/26560877797/job/78243326387

Feel free to open a new pr for this.
Would it be possible to make the doclint errors enable only when passing a -PenableJavadocError flag, and then make a dedicated CI task to check the doc, that fails with a notice without stopping the build? It would be less frustrating for contributors i think.

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