Task/gen javadoc #650
Open
Task/gen javadoc #650
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yannicklamprecht
force-pushed
the
task/gen-javadoc
branch
22 times, most recently
from
090ca97 to
511bd27
Compare
yannicklamprecht
force-pushed
the
task/gen-javadoc
branch
from
511bd27 to
59947b2
Compare
rainbowdashlabs
requested changes
Jan 5, 2025
Comment on lines
+26
to
+52
| /** | ||
| * Returns the result type of this analyzer result. | ||
| * | ||
| * @return the result type, which is always {@link ResultType#NO_MATCH} | ||
| */ | ||
| @Override | ||
| public ResultType resultType() { | ||
| return ResultType.NO_MATCH; | ||
| } | ||
|
|
||
| /** | ||
| * Converts this analyzer result to a snapshot. | ||
| * | ||
| * @return this analyzer result as a snapshot | ||
| */ | ||
| @Override | ||
| public ResultSnapshot toSnapshot() { | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds this analyzer result to the provided embed builder. | ||
| * | ||
| * @param guild the guild where the result was generated | ||
| * @param entry the result entry | ||
| * @param builder the localized embed builder to add the result to | ||
| */ |
Owner
There was a problem hiding this comment.
Not sure that documenting overridden methods again provides much value.
Comment on lines
+36
to
+41
| /** | ||
| * Handles the slash command interaction event. | ||
| * | ||
| * @param event the SlashCommandInteractionEvent | ||
| * @param context the EventContext | ||
| */ |
Owner
There was a problem hiding this comment.
Same here and for all other command handlers. No need to document overrides
Comment on lines
+19
to
+21
| /** | ||
| * Handler for the "add reaction" slash command, which adds a reaction to a message. | ||
| */ |
Comment on lines
+54
to
+58
| /** | ||
| * Handles the event when the bot joins a guild. | ||
| * | ||
| * @param event the GuildJoinEvent | ||
| */ |
Owner
There was a problem hiding this comment.
No need to document methods overridden from the ListenerAdapter
Comment on lines
+104
to
+108
| /** | ||
| * Handles the message deletion event. | ||
| * | ||
| * @param event the message deletion event | ||
| */ |
Comment on lines
+137
to
+141
| /** | ||
| * Handles the event when a reaction emoji is removed from a message. | ||
| * | ||
| * @param event the message reaction remove emoji event | ||
| */ |
Owner
There was a problem hiding this comment.
Might tend to repeat myself. Will not do it for future listeners
| */ | ||
| @SuppressWarnings("unused") | ||
| public static final class Pastel { | ||
| /** |
Owner
There was a problem hiding this comment.
Not sure whether comments here add actual value to readability of the code.
Co-authored-by: Lilly Tempest <46890129+rainbowdashlabs@users.noreply.github.com>
…java Co-authored-by: Lilly Tempest <46890129+rainbowdashlabs@users.noreply.github.com>
Co-authored-by: Lilly Tempest <46890129+rainbowdashlabs@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
I made changes to commands
I added new localisation codes
I made changes to the database
I made changes to internal structure
Short Description
Generated Javadoc
Detailed Description
Closes #