Revert "Enable Javadoc doclint errors"#2826
Conversation
This reverts commit 5f6eca8.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request modifies Javadoc configurations in the Gradle build files to disable strict doclint checks and updates various Javadoc comments across the codebase. The reviewer identified several issues introduced in the Javadoc updates, including mismatched @param tag names in TechniqueDefLogic.java and BufferObject.java, an invalid @param tag on a no-argument constructor in StructStd140BufferObject.java, and invalid HTML formatting (using <li> directly inside <p> without a wrapping <ul> tag) in Action.java. Code suggestions have been provided to fix these Javadoc issues.
| * @param geometry The geometry to render | ||
| * @param lights Lights which influence the geometry. | ||
| * @param lastBindUnits the most recently used bind units | ||
| * @param lastTexUnit the index of the most recently used texture unit |
There was a problem hiding this comment.
The @param tag name lastTexUnit does not match the method parameter name lastBindUnits. This will cause a Javadoc warning or error. Please correct the @param tag to match the parameter name.
| * @param lastTexUnit the index of the most recently used texture unit | |
| * @param lastBindUnits the index of the most recently used texture unit |
References
- When identifying missing or incorrect Javadoc, provide a code suggestion to fix it directly.
| * Set AccessHint to hint the renderer on how to access this data. | ||
| * | ||
| * @param accessHint the access hint | ||
| * @param natureHint |
There was a problem hiding this comment.
The @param tag name natureHint does not match the method parameter name accessHint. This will cause a Javadoc warning or error. Please correct the @param tag to match the parameter name.
| * @param natureHint | |
| * @param accessHint the access hint |
References
- When identifying missing or incorrect Javadoc, provide a code suggestion to fix it directly.
| /** | ||
| * Create an empty Struct buffer | ||
| * | ||
| * @param str |
There was a problem hiding this comment.
A @param str tag has been added to the Javadoc for a constructor that takes no parameters. This is incorrect and will cause a Javadoc error. Please remove this @param tag.
| * @param str | |
| * |
References
- When identifying missing or incorrect Javadoc, provide a code suggestion to fix it directly.
| * <p> | ||
| * Notes : | ||
| * <li> The sequence of tweens is determined by {@link com.jme3.anim.tween.Tweens} utility class and the {@link BaseAction} interpolates that sequence. </li> | ||
| * <li> This implementation mimics the {@link com.jme3.anim.tween.AbstractTween}, but it delegates the interpolation method {@link Tween#interpolate(double)} | ||
| * to the {@link BlendableAction} class. </li> | ||
| * </ul> | ||
| * </p> |
There was a problem hiding this comment.
The Javadoc formatting has been changed to use <li> tags directly inside a <p> tag. This is invalid HTML, as <li> elements must be children of <ul>, <ol>, or <menu> elements. This will likely cause rendering issues in the generated Javadoc.
To fix this, you should wrap the <li> elements in a <ul> tag. The original structure was correct in this regard. If the goal was to fix a doclint warning, a better approach would be to wrap the heading and the list in a single <p> tag.
| * <p> | |
| * Notes : | |
| * <li> The sequence of tweens is determined by {@link com.jme3.anim.tween.Tweens} utility class and the {@link BaseAction} interpolates that sequence. </li> | |
| * <li> This implementation mimics the {@link com.jme3.anim.tween.AbstractTween}, but it delegates the interpolation method {@link Tween#interpolate(double)} | |
| * to the {@link BlendableAction} class. </li> | |
| * </ul> | |
| * </p> | |
| * <p>Notes: | |
| * <ul> | |
| * <li> The sequence of tweens is determined by {@link com.jme3.anim.tween.Tweens} utility class and the {@link BaseAction} interpolates that sequence. </li> | |
| * <li> This implementation mimics the {@link com.jme3.anim.tween.AbstractTween}, but it delegates the interpolation method {@link Tween#interpolate(double)} | |
| * to the {@link BlendableAction} class. </li> | |
| * </ul></p> |
References
- When identifying missing or incorrect Javadoc, provide a code suggestion to fix it directly.
1 participant
Reverts #2799