Skip to content

Add Javadoc to 9 utility and integration classes (41 warnings fixed)#254

Merged
BenCodez merged 17 commits intomasterfrom
copilot/fix-javadoc-warnings-again
Feb 16, 2026
Merged

Add Javadoc to 9 utility and integration classes (41 warnings fixed)#254
BenCodez merged 17 commits intomasterfrom
copilot/fix-javadoc-warnings-again

Conversation

Copy link
Contributor

Copilot AI commented Feb 15, 2026

Fixes 41 javadoc warnings across utility classes, event listeners, and third-party integration handlers. Part of broader effort to eliminate 400+ warnings blocking API documentation generation.

Files Modified

Core utilities:

  • MiscUtils - Utility methods for date manipulation, broadcasting, metadata
  • Layout - Book GUI layout rendering
  • Listener<T> - Generic value request listener

Integration handlers:

  • LoginSecurityLogin - LoginSecurity auth event listener
  • ItemsAdderHandle - ItemsAdder custom item integration
  • ItemModelHandler - Item model customization
  • JavascriptEngineHandler - Cross-JVM Javascript engine management
  • JavascriptPlaceholderRequest - Javascript placeholder abstraction

Effects:

  • ItemMessage - Item tooltip-based popup messages

Key Pattern

Lombok's delombok generates getter/setter methods that inherit field-level javadoc. Field javadoc must include both @return and @param tags:

/**
 * BungeeCord channel name.
 * 
 * @return the bungee channel name
 * @param bungeeChannel the channel name to set
 */
@Getter
@Setter
private String bungeeChannel;

This generates:

public String getBungeeChannel() { ... }  // Inherits @return
public void setBungeeChannel(String bungeeChannel) { ... }  // Inherits @param

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 6 commits February 15, 2026 20:38
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix all Javadoc warnings in project Fix Javadoc warnings for Lombok-generated methods in AdvancedCoreLoginEvent and AdvancedCorePlugin Feb 15, 2026
Copilot AI requested a review from BenCodez February 15, 2026 20:55
Copilot AI and others added 8 commits February 15, 2026 21:14
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
…edCoreUser.java

- Added Javadoc to all public constructors
- Added Javadoc to all public methods without existing documentation
- Included @param tags for all parameters
- Included @return tags for all non-void methods
- Used concise descriptions matching existing codebase style
- Did not modify any existing javadoc or private methods

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
- BInventory.java: Added javadoc for all @Getter/@Setter fields and methods (36 warnings fixed)
- BInventoryButton.java: Added javadoc for all @Getter/@Setter fields and methods (24 warnings fixed)
- BedrockNameResolver.java: Added javadoc for all public methods and inner classes (18 warnings fixed)
- BookWrapper.java: Added javadoc for all @Getter/@Setter fields and methods (17 warnings fixed)
- BInventoryListener.java: Added class and constructor javadoc (3 warnings fixed)
- BooleanListener.java: Added class javadoc (1 warning fixed)
- AdvancedCoreUser.java: Verified @Setter field has @param tag (1 warning was already fixed)

All javadoc comments include:
- @param tags for parameters
- @return tags for non-void methods and @Getter fields
- @param tags for @Setter fields
- Concise descriptions matching existing code style

Result: 0 javadoc warnings for these files when running:
mvn clean deploy -U -P javadoc -DskipTests

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Fixed javadoc warnings in:
- BungeeTimeChecker.java (31 warnings)
- BossBar.java (13 warnings)
- ConfigEditor.java (9 warnings)
- DirectlyDefinedReward.java (8 warnings)
- DefinedReward.java (8 warnings)
- CommandLoader.java (7 warnings)
- CalculatingPlaceholder.java (7 warnings)
- CommandHandler.java (6 warnings)
- DateChangedEvent.java (3 warnings)
- ChoiceGUI.java (3 warnings)
- DayChangeEvent.java (2 warnings)
- CMIHandler.java (2 warnings)
- PlaceHolder.java (1 warning)

Added complete javadoc for all public/protected classes, methods, constructors,
and fields including @param, @return tags as required. All Lombok @Getter/@Setter
annotations now have proper documentation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Added comprehensive javadoc comments to all public/protected classes, methods, constructors, and fields that were missing documentation in:

1. EditGUIValue.java - 21 warnings fixed
2. FullInventoryHandler.java - 13 warnings fixed
3. GlobalDataHandler.java - 11 warnings fixed
4. EditGUIValueType.java - 8 warnings fixed
5. EditGUIButton.java - 8 warnings fixed
6. GlobalDataHandlerProxy.java - 7 warnings fixed
7. FileThread.java - 5 warnings fixed
8. FileDirectoryException.java - 5 warnings fixed
9. EditGUIValueInventory.java - 4 warnings fixed
10. FireworkHandler.java - 3 warnings fixed
11. EditGUIValueString.java - 3 warnings fixed
12. EditGUIValueNumber.java - 3 warnings fixed
13. EditGUIValueList.java - 3 warnings fixed
14. EditGUIValueBoolean.java - 3 warnings fixed
15. EditGUI.java - 3 warnings fixed

All 100 warnings in these files have been resolved. The remaining 100 warnings in the project are in other files not part of this task.

Changes include:
- Added class-level javadoc for all public/protected classes
- Added @param tags for all method parameters
- Added @return tags for all non-void methods
- Added proper javadoc for Lombok @Getter and @Setter fields
- Fixed javadoc placement for @deprecated methods
- Added documentation for abstract methods

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Updated javadoc for Lombok @Getter/@Setter fields to include both:
- @return tag for the generated getter method
- @param tag for the generated setter method

This ensures the generated setter methods have proper parameter documentation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- GlobalMySQL.java: 34 warnings fixed
- GUIHandler.java: 16 warnings fixed
- Hologram.java: 13 warnings fixed
- ItemBuilder.java: 12 warnings fixed
- Inject.java: 10 warnings fixed
- HologramHandler.java: 6 warnings fixed
- InputMethod.java: 4 warnings fixed
- GUIMethod.java: 4 warnings fixed
- GUISession.java: 1 warning fixed

All public/protected classes, methods, and constructors now have
proper javadoc comments with @param and @return tags.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI and others added 2 commits February 16, 2026 03:36
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
…(20 warnings)

Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Copilot AI changed the title Add comprehensive Javadoc to eliminate 300+ warnings from Maven javadoc:jar Add Javadoc to 9 utility and integration classes (41 warnings fixed) Feb 16, 2026
@BenCodez BenCodez marked this pull request as ready for review February 16, 2026 03:46
@BenCodez BenCodez merged commit bc17fd0 into master Feb 16, 2026
4 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