-
-
Notifications
You must be signed in to change notification settings - Fork 15
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
Task/gen javadoc #650
base: dev
Are you sure you want to change the base?
Task/gen javadoc #650
Conversation
090ca97
to
511bd27
Compare
511bd27
to
59947b2
Compare
public MessageContext getCombinedContext(Message message, @Nullable Settings settings) { | ||
return getCombinedContext(message.getMember(), message, settings); | ||
} | ||
|
||
/** | ||
* Gets the combined context for the specified member and message. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* Gets the combined context for the specified member and message. | |
* Gets the combined voice and message context for the specified member and message. |
/** | ||
* 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 | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure that documenting overridden methods again provides much value.
/** | ||
* Handles the slash command interaction event. | ||
* | ||
* @param event the SlashCommandInteractionEvent | ||
* @param context the EventContext | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here and for all other command handlers. No need to document overrides
/** | ||
* Handler for the "add reaction" slash command, which adds a reaction to a message. | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is wrong
/** | ||
* Handler for the main slash command related to reactions. | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/** | |
* Handler for the main slash command related to reactions. | |
*/ | |
/** | |
* Handler to set the main reaction for reputation. | |
*/ |
/** | ||
* Retrieves command statistics for a specific week. | ||
* | ||
* @param week the week number | ||
* @return the command statistics for the specified week | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/** | |
* Retrieves command statistics for a specific week. | |
* | |
* @param week the week number | |
* @return the command statistics for the specified week | |
*/ | |
/** | |
* Retrieves command statistics in a weekly resolution. | |
* | |
* @param week the week offset from the current week. | |
* @return the command statistics after the specified offset in weekly resolution | |
*/ |
Those functions are all super bad labeled. Its always about resolution and offset. this probably applies to all doc strings of metrics.
/** | ||
* Handles the event when the bot joins a guild. | ||
* | ||
* @param event the GuildJoinEvent | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need to document methods overridden from the ListenerAdapter
/** | ||
* Handles the message deletion event. | ||
* | ||
* @param event the message deletion event | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here with overrides
/** | ||
* Handles the event when a reaction emoji is removed from a message. | ||
* | ||
* @param event the message reaction remove emoji event | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might tend to repeat myself. Will not do it for future listeners
@@ -20,21 +20,69 @@ private Colors() { | |||
*/ | |||
@SuppressWarnings("unused") | |||
public static final class Pastel { | |||
/** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure whether comments here add actual value to readability of the code.
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 #