Skip to content

Refactor: SimpleApplication optimization + javadoc #2490

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

capdevon
Copy link
Contributor

@capdevon capdevon commented Jun 12, 2025

This pull request introduces significant improvements to the SimpleApplication base class. The primary focus is on enhancing the Javadoc documentation across the entire class, providing clearer explanations for its purpose, default AppStates, key bindings, and the roles of rootNode and guiNode.

Key changes include:

  • Comprehensive Javadoc: All fields and methods, now have detailed and accurate Javadoc comments, explaining their parameters, return values, and behavior.

  • Clarity and Maintainability: The enhanced documentation and subtle code improvements contribute to better code clarity, making it easier for developers to understand and extend SimpleApplication.

@yaRnMcDonuts yaRnMcDonuts added this to the v3.9.0 milestone Jun 13, 2025
@capdevon capdevon changed the title Refactor: enhance javadoc & optimize SimpleApplication class Refactor: SimpleApplication optimization + javadoc Jun 13, 2025
@yaRnMcDonuts
Copy link
Member

yaRnMcDonuts commented Jun 16, 2025

Looks good to me. I don't see any risks after reviewing everything, but I'm going to leave this one open for a bit longer and do another look through right before merging, just because it is related to such an important core class.

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