Skip to content

Enhance BitmapFont and BitmapText Javadoc #2534

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 2 commits into from
Aug 17, 2025

Conversation

capdevon
Copy link
Contributor

@capdevon capdevon commented Jul 1, 2025

BitmapFont

  • Adds comprehensive Javadoc comments to the BitmapFont class, explaining the purpose, usage, and parameters for public methods and constructors.
  • Refactors import statements for clarity and explicitness.
  • Improves class-level documentation to describe the font’s role, capabilities, and usage in the engine.
  • Reorders and documents the rightToLeft property and associated getter/setter for better clarity.
  • Enhances documentation for methods related to character set, font pages, and font styling.
  • Updates and expands comments on text width calculation logic, including details on color tag parsing and kerning.
  • Restores and documents the read and write (serialization) methods, moving them to the end of the class for organization.
  • Improves code consistency and readability throughout the class for maintainability and developer onboarding.

BitmapText

  • Adds detailed Javadoc comments to public methods and constructors in the BitmapText class.
  • Clarifies the purpose, usage, and parameters of each method for improved API usability.
  • Improves code readability and consistency with enhanced descriptions and minor cleanups.
  • Helps new and existing users better understand and utilize BitmapText class features.

These updates aim to make the codebase more understandable for contributors and maintainers, while preserving all existing functionality.

Copy link
Contributor

@codex128 codex128 left a comment

Choose a reason for hiding this comment

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

These changes look fine.

@riccardobl riccardobl added the Refactoring and Cleanup This PR is all about improving code quality and javadoc. label Aug 10, 2025
@yaRnMcDonuts yaRnMcDonuts added this to the v3.9.0 milestone Aug 17, 2025
@yaRnMcDonuts yaRnMcDonuts merged commit 2ca556a into jMonkeyEngine:master Aug 17, 2025
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Refactoring and Cleanup This PR is all about improving code quality and javadoc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants