Skip to content

Add javadoc documentation for 56 missing methods across 15 files#1493

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

Add javadoc documentation for 56 missing methods across 15 files#1493
BenCodez merged 14 commits intomasterfrom
copilot/fix-javadoc-warnings-again

Conversation

Copy link
Contributor

Copilot AI commented Feb 15, 2026

Summary

Added javadoc comments to 56 undocumented methods, constructors, and enum constants across 15 files, reducing remaining warnings from 100 to 44.

Changes by Component

Event System (6 files, 21 warnings)

  • VoteMilestoneRewardEvent - getter methods for user, UUID, player name, value, reward path, placeholders
  • VotePartyEvent - constructor
  • Event listener classes - constructors and event handlers

Vote Milestones (4 files, 16 warnings)

  • VoteMilestoneTotal enum - all 6 constants (ALLTIME_VOTES, DAILY_VOTES, etc.) plus getValue/parse methods
  • VoteMilestoneGroupSelect enum - class-level documentation
  • Config and migrator utility classes

Vote Reminders (2 files, 12 warnings)

  • VoteRemindersListener - all 5 event handlers (onPostVote, onLogin, onQuit, onCoolDownEnd variants)
  • VoteRemindersLegacyMigrator - migration utility with param/return documentation

Vote Party (1 file, 16 warnings)

  • Complete documentation for vote party system: registration, rewards, resets, event handlers
  • All getter/setter pairs and overloaded methods

GUI Components (2 files, 4 warnings)

  • VoteLast and VoteNext - constructors with proper param documentation

Example

// Before
public void giveReward(VotingPluginUser user, boolean useBungee) {
    if (plugin.getSpecialRewardsConfig().getVotePartyUserVotesRequired() > 0) {

// After
/**
 * Gives vote party reward to a user.
 *
 * @param user the voting plugin user
 * @param useBungee whether to use Bungee processing
 */
public void giveReward(VotingPluginUser user, boolean useBungee) {

Remaining Work

44 warnings remain in 2 files:

  • VoteRemindersManager.java (17) - inner classes and manager methods
  • VoteMilestonesManager.java (27) - complex milestone processing logic

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

Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix Javadoc warnings and clean build Fix 100 javadoc warnings across proxy and broadcast classes Feb 15, 2026
Copilot AI requested a review from BenCodez February 15, 2026 21:34
Copilot AI changed the title Fix 100 javadoc warnings across proxy and broadcast classes Document remaining 100 javadoc warnings found in jar build Feb 15, 2026
Copilot AI and others added 3 commits February 15, 2026 21:59
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Fixed javadoc warnings in:
- Config.java (1 warning)
- ConfigVoteSites.java (18 warnings)
- CoolDownCheck.java (15 warnings)
- GUI.java (9 warnings)
- DiscordHandler.java (5 warnings)
- INonVotedPlayersStorage.java (5 warnings)
- MultiProxyHandler.java (34 warnings)
- MultiProxyMethod.java (4 warnings)
- MultiProxyServerSocketConfiguration.java (4 warnings)
- DiscordWebhookPayloadBuilder.java (3 warnings)
- GsonDataNode.java (2 warnings)

All changes are documentation-only, no code logic modified.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Copilot AI and others added 3 commits February 16, 2026 00:38
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
- Add javadoc to ProxyVoteCacheTable.java (26 warnings fixed)
- Add javadoc to ProxyOnlineVoteCacheTable.java (21 warnings fixed)
- Add javadoc to ProxyNonVotedPlayersTable.java (15 warnings fixed)
- Add javadoc to ProxyTimedVoteCacheTable.java (15 warnings fixed)

Total: Fixed 77 javadoc warnings across 4 files with no code logic changes.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- ServerData.java: Added javadoc for 28 methods
- ShopFile.java: Added javadoc for class and 21 methods
- TopVoter.java: Added javadoc for enum, constants, and 13 methods
- SpecialRewardType.java: Added javadoc for enum, constants, and 2 methods
- SpecialRewardsConfig.java: Added javadoc for class and 11 methods
- TimeQueueHandler.java: Added javadoc for class and 7 methods
- SignHandler.java: Added javadoc for constructor and 4 methods
- SpecialRewards.java: Added javadoc for constructor and 3 methods
- Signs.java: Added javadoc for constructor

All warnings from these 9 files have been resolved.

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

- VoteCacheHandler.java (23 warnings)
- UserManager.java (19 warnings)
- TopVoterHandler.java (19 warnings)
- VelocityConfig.java (6 warnings)
- VoteHelp.java (5 warnings)
- VoteReminderCooldownStore.java (4 warnings)
- UserDataVoteReminderCooldownStore.java (4 warnings)
- TopVoterPlayer.java (4 warnings)
- VoteEventVelocity.java (3 warnings)
- VoteEventBungee.java (3 warnings)
- VelocityJsonVoteCache.java (2 warnings)
- VelocityJsonNonVotedPlayersCache.java (2 warnings)
- VoteGUI.java (2 warnings)
- VoteBest.java (2 warnings)
- VoteBroadcastType.java (2 warnings)

All changes are documentation-only with no code logic modifications.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI changed the title Document remaining 100 javadoc warnings found in jar build Add javadoc documentation to 377 methods across 51 files Feb 16, 2026
Co-authored-by: BenCodez <17074231+BenCodez@users.noreply.github.com>
Copilot AI and others added 4 commits February 16, 2026 03:11
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 Add javadoc documentation to 377 methods across 51 files Add javadoc documentation for 56 missing methods across 15 files Feb 16, 2026
@BenCodez BenCodez marked this pull request as ready for review February 16, 2026 03:24
@BenCodez BenCodez merged commit f37a067 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