Skip to content

Javadoc descriptions#978

Merged
jadeandtea merged 3 commits into
Bram-Hub:devfrom
busabj:Javadoc-descriptions
Apr 23, 2026
Merged

Javadoc descriptions#978
jadeandtea merged 3 commits into
Bram-Hub:devfrom
busabj:Javadoc-descriptions

Conversation

@busabj
Copy link
Copy Markdown
Collaborator

@busabj busabj commented Apr 21, 2026

Description

Throughout a lot of files, I implemented Javadoc annotations. I felt this was important because it makes the code a lot more understandable for anyone viewing it. Adding these annotations will also help complete the published Javadocs be more complete and understandable.

Closes #(issue)

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Enhancement (improvement to an already existing feature)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

How Has This Been Tested?

There is no need to test the comments. I thoroughly read through a lot of the code to make sure that the annotations are accurate and clear.

Checklist:

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@jadeandtea jadeandtea changed the base branch from master to dev April 21, 2026 20:48
@jadeandtea jadeandtea merged commit 3b73cdf into Bram-Hub:dev Apr 23, 2026
9 checks passed
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