EmitterShape: javadoc improvements #2420
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The interface code has been updated with two key changes for conciseness and adherence to Java conventions. 1. The explicit public keyword has been removed from the interface methods, as interface methods are implicitly public by default. 2. The EmitterShape interface no longer explicitly extends Cloneable. This is because the JmeCloneable interface, which EmitterShape already extends, itself extends Cloneable, thus making the direct extension redundant
yaRnMcDonuts
approved these changes
May 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces several enhancements to the EmitterShape class hierarchy to improve code clarity and maintainability. The changes include:
Removal of redundant
Cloneableextension: TheEmitterShapeinterface extendsJmeCloneable, which itself already extendsCloneable. The explicit extension ofCloneableinEmitterShapeis therefore redundant and has been removed.Improved Javadoc documentation: Comprehensive Javadoc documentation has been added to the
EmitterPointShape,EmitterSphereShape, andEmitterBoxShapeclasses, including field and method descriptions, to improve class understanding and usability.