Skip to content

Feat: WAVLoader: Ensures clean instance state, optimization + javadoc #2496

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

Merged
merged 1 commit into from
Jun 29, 2025

Conversation

capdevon
Copy link
Contributor

@capdevon capdevon commented Jun 14, 2025

Key improvements include:

  • Comprehensive Javadoc: Detailed documentation has been added to all classes, methods, and significant fields, making the code much easier to understand and use.
  • Enhanced Readability: Variables have been consistently renamed for better clarity and adherence to Java naming conventions .
  • Increased Robustness & Clean State:
    • The WAVLoader's instance variables are now explicitly nullified or reset after each load operation, ensuring a clean state for subsequent uses and proper resource management. (see ResettableInputStream, AudioData, AudioBuffer, AudioStream)
  • Minor Optimizations: Buffer reading has been optimized, and logging messages are now more efficient.

These changes collectively make the WAVLoader more reliable and simpler to integrate and maintain within the jMonkeyEngine asset pipeline.

@yaRnMcDonuts yaRnMcDonuts added this to the v3.9.0 milestone Jun 16, 2025
@yaRnMcDonuts yaRnMcDonuts merged commit 3220b29 into jMonkeyEngine:master Jun 29, 2025
16 checks passed
@capdevon capdevon deleted the capdevon-WAVLoader branch June 30, 2025 09:59
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