Sheldan/abstracto
1
0
Fork 0
mirror of https://github.com/Sheldan/abstracto.git synced 2026-03-13 18:23:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

[AB-xx] fixing javadoc

Browse Source
This commit is contained in:
Sheldan
2022-10-16 13:16:50 +02:00
parent ce90370b9c
commit e6802a0851
15 changed files with 26 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/exception/AssignableRoleAlreadyDefinedException.java
View File

@@ -9,7 +9,7 @@ import net.dv8tion.jda.api.entities.Role;
/**
* Exception thrown in case the {@link dev.sheldan.abstracto.assignableroles.model.database.AssignableRole} has already been
* defined for an {@link dev.sheldan.abstracto.assignableroles.model.database.AssignableRolePlace}. This is identified
* via the {@link net.dv8tion.jda.api.entities.Emote} which is used to react.
* via the emote which is used to react.
*/
public class AssignableRoleAlreadyDefinedException extends AbstractoRunTimeException implements Templatable {
private final AssignableRoleAlreadyDefinedExceptionModel model;

2
abstracto-application/abstracto-modules/assignable-roles/assignable-roles-int/src/main/java/dev/sheldan/abstracto/assignableroles/exception/AssignableRolePlaceAlreadyExistsException.java
View File

@@ -6,7 +6,7 @@ import dev.sheldan.abstracto.core.templating.Templatable;
/**
* Exception thrown in case the {@link dev.sheldan.abstracto.assignableroles.model.database.AssignableRolePlace place}
* identified by {@link dev.sheldan.abstracto.assignableroles.model.database.AssignableRolePlace#key}
* identified by {@link dev.sheldan.abstracto.assignableroles.model.database.AssignableRolePlace} key
*/
public class AssignableRolePlaceAlreadyExistsException extends AbstractoRunTimeException implements Templatable {

2
abstracto-application/abstracto-modules/experience-tracking/experience-tracking-int/src/main/java/dev/sheldan/abstracto/experience/model/template/LeaderBoardEntryModel.java
View File

@@ -26,7 +26,7 @@ public class LeaderBoardEntryModel implements Serializable {
@Setter
private transient Member member;
/**
* The position this {@link dev.sheldan.abstracto.core.models.database.AUserInAServer user} in this server has, ordered by experience {@link AUserExperience#experience}
* The position this {@link dev.sheldan.abstracto.core.models.database.AUserInAServer user} in this server has, ordered by experience {@link AUserExperience} experience
*/
private Integer rank;
}

4
abstracto-application/abstracto-modules/experience-tracking/experience-tracking-int/src/main/java/dev/sheldan/abstracto/experience/service/management/UserExperienceManagementService.java
View File

@@ -50,11 +50,11 @@ public interface UserExperienceManagementService {
List<AUserExperience> loadAllUsers(AServer server);
/**
* Retrieves a list of {@link AUserExperience} ordered by {@link AUserExperience#experience} and only returns the positions between {@code start} and @{code end}.
* Retrieves a list of {@link AUserExperience} ordered by {@link AUserExperience} experience and only returns the positions between {@code start} and @{code end}.
* @param server The {@link AServer} to retrieve the users for
* @param page The page to retrieve
* @param size The size of each page
* @return A list desc ordered by {@link AUserExperience#experience} only containing the elements between {@code start} and @{code end}
* @return A list desc ordered by {@link AUserExperience} experience only containing the elements between {@code start} and @{code end}
*/
List<AUserExperience> findLeaderBoardUsersPaginated(AServer server, Integer page, Integer size);

2
abstracto-application/abstracto-modules/modmail/modmail-impl/src/main/java/dev/sheldan/abstracto/modmail/command/Close.java
View File

@@ -34,7 +34,7 @@ import java.util.concurrent.CompletableFuture;
/**
* Closes the mod mail thread: logs the messages to the log post target, if the feature has the appropriate
* {@link dev.sheldan.abstracto.core.config.FeatureMode}, deletes the {@link net.dv8tion.jda.api.entities.MessageChannel}.
* {@link dev.sheldan.abstracto.core.config.FeatureMode}, deletes the message channel.
* This command takes an optional parameter, the note, which will be replaced with a default value, if not present
*/
@Component

2
abstracto-application/abstracto-modules/modmail/modmail-impl/src/main/java/dev/sheldan/abstracto/modmail/setup/ModMailCategoryDelayedAction.java
View File

@@ -21,7 +21,7 @@ public class ModMailCategoryDelayedAction implements DelayedAction {
/**
* Sets the config key of MODMAIL_CATEGORY to the given category ID contained in the {@link DelayedActionConfig}
* @param delayedActionConfig An instance of {@link ModMailCategoryDelayedActionConfig} containing the ID
* of the {@link net.dv8tion.jda.api.entities.Category} and the ID of the
* of the category and the ID of the
* {@link net.dv8tion.jda.api.entities.Guild} to change
*/
@Override

2
abstracto-application/abstracto-modules/modmail/modmail-int/src/main/java/dev/sheldan/abstracto/modmail/exception/ModMailCategoryIdException.java
View File

@@ -8,7 +8,7 @@ import lombok.Setter;
/**
* This exception is thrown when a {@link net.dv8tion.jda.api.entities.Member} tries to set the mod mail category
* via a command, and the new value does not qualify as a valid {@link net.dv8tion.jda.api.entities.Category}
* via a command, and the new value does not qualify as a valid category
* in the member executes the command in
*/
@Getter

4
abstracto-application/abstracto-modules/modmail/modmail-int/src/main/java/dev/sheldan/abstracto/modmail/service/management/ModMailThreadManagementService.java
View File

@@ -17,7 +17,7 @@ import java.util.Optional;
public interface ModMailThreadManagementService {
/**
* Retrieves a {@link ModMailThread} found in the {@link net.dv8tion.jda.api.entities.MessageChannel} given by the ID of the channel
* Retrieves a {@link ModMailThread} found in the message channel given by the ID of the channel
* @param channelId The id of the channel to retrieve the {@link ModMailThread} for
* @throws ChannelNotFoundException if an appropriate {@link AChannel} was not found
* @return The instance of {@link ModMailThread} if it exists, null if none was found
@@ -39,7 +39,7 @@ public interface ModMailThreadManagementService {
ModMailThread getById(Long modMailThreadId);
/**
* Retrieves a {@link ModMailThread} found in the {@link net.dv8tion.jda.api.entities.MessageChannel} given by the
* Retrieves a {@link ModMailThread} found in the message channel given by the
* {@link AChannel} object
* @param channel The {@link AChannel} object to search a mod mail thread for
* @return The found mod mail thread, or null if none was found

2
abstracto-application/abstracto-modules/statistic/statistic-impl/src/main/java/dev/sheldan/abstracto/statistic/emote/command/SyncTrackedEmotes.java
View File

@@ -22,7 +22,7 @@ import java.util.concurrent.CompletableFuture;
/**
* This command can be used to synchronize the state of {@link dev.sheldan.abstracto.statistic.emote.model.database.TrackedEmote}
* in the database, with the state of {@link net.dv8tion.jda.api.entities.Emote} in the {@link net.dv8tion.jda.api.entities.Guild}.
* in the database, with the state of emote in the {@link net.dv8tion.jda.api.entities.Guild}.
* It will mark emotes not in the guild anymore and add emotes which are not yet tracked.
*/
@Component

2
abstracto-application/abstracto-modules/statistic/statistic-impl/src/main/java/dev/sheldan/abstracto/statistic/emote/command/TrackEmote.java
View File

@@ -25,7 +25,7 @@ import java.util.List;
/**
* This command can be used to track one individual {@link TrackedEmote} newly, or set the emote to be tracked again.
* This can either be done via providing the {@link net.dv8tion.jda.api.entities.Emote} or via ID.
* This can either be done via providing the emote or via ID.
*/
@Component
public class TrackEmote extends AbstractConditionableCommand {

4
abstracto-application/abstracto-modules/statistic/statistic-impl/src/main/java/dev/sheldan/abstracto/statistic/emote/repository/UsedEmoteRepository.java
View File

@@ -21,8 +21,8 @@ public interface UsedEmoteRepository extends JpaRepository<UsedEmote, UsedEmoteD
/**
* Selects the {@link UsedEmote} for one particular {@link dev.sheldan.abstracto.statistic.emote.model.database.TrackedEmote}
* for the current date.
* @param emoteId The ID of the {@link net.dv8tion.jda.api.entities.Emote} which is being tracked
* @param server_id The ID of the {@link net.dv8tion.jda.api.entities.Guild} which is the server where the {@link net.dv8tion.jda.api.entities.Emote}
* @param emoteId The ID of the emote which is being tracked
* @param server_id The ID of the {@link net.dv8tion.jda.api.entities.Guild} which is the server where the emote
* is being tracked
* @return An {@link Optional} containing a possible {@link UsedEmote}, if it exists for the criteria, an empty Optional otherwise.
*/

2
abstracto-application/abstracto-modules/statistic/statistic-impl/src/main/java/dev/sheldan/abstracto/statistic/emote/service/TrackedEmoteRunTimeStorage.java
View File

@@ -19,7 +19,7 @@ public class TrackedEmoteRunTimeStorage {
* map will not contain many keys, because the {@link dev.sheldan.abstracto.statistic.emote.job.EmotePersistingJob}
* will remove them a minute later. The Map within the current minute will contain every server as a key in which
* there were emotes used in the particular minute. {@link PersistingEmote} does not contain any JDA related objects
* but only the information necessary to identify any {@link net.dv8tion.jda.api.entities.Emote}.
* but only the information necessary to identify any emote.
*/
private HashMap<Long, Map<Long, List<PersistingEmote>>> trackedEmotes = new HashMap<>();

12
abstracto-application/abstracto-modules/statistic/statistic-int/src/main/java/dev/sheldan/abstracto/statistic/emote/model/PersistingEmote.java
View File

@@ -13,15 +13,15 @@ import lombok.Setter;
@Builder
public class PersistingEmote {
/**
* The global unique ID of the {@link net.dv8tion.jda.api.entities.Emote}
* The global unique ID of the emote
*/
private Long emoteId;
/**
* The name of the {@link net.dv8tion.jda.api.entities.Emote} in Discord
* The name of the emote in Discord
*/
private String emoteName;
/**
* Whether or not the {@link net.dv8tion.jda.api.entities.Emote} is animated
* Whether or not the emote is animated
*/
private Boolean animated;
/**
@@ -30,15 +30,15 @@ public class PersistingEmote {
*/
private Boolean external;
/**
* Only if the emote is external: the URL where the source image of the {@link net.dv8tion.jda.api.entities.Emote} is stored on Discord servers
* Only if the emote is external: the URL where the source image of the emote is stored on Discord servers
*/
private String externalUrl;
/**
* The amount of times the {@link net.dv8tion.jda.api.entities.Emote} has been used.
* The amount of times the emote has been used.
*/
private Long count;
/**
* The ID of the {@link net.dv8tion.jda.api.entities.Guild} on which the {@link net.dv8tion.jda.api.entities.Emote} has been used on
* The ID of the {@link net.dv8tion.jda.api.entities.Guild} on which the emote has been used on
*/
private Long serverId;
}

2
abstracto-application/abstracto-modules/statistic/statistic-int/src/main/java/dev/sheldan/abstracto/statistic/emote/model/database/TrackedEmote.java
View File

@@ -34,7 +34,7 @@ public class TrackedEmote implements Serializable, Fakeable {
private AServer server;
/**
* The name of the {@link net.dv8tion.jda.api.entities.Emote} which is the same how it is identified within Discord.
* The name of the emote which is the same how it is identified within Discord.
*/
@Column(name = "name", length = 32)
private String emoteName;

8
abstracto-application/abstracto-modules/statistic/statistic-int/src/main/java/dev/sheldan/abstracto/statistic/emote/service/UsedEmoteService.java
View File

@@ -16,7 +16,7 @@ public interface UsedEmoteService {
* This {@link EmoteStatsModel} will contain all {@link TrackedEmote} from the server
* @param server The {@link AServer} to retrieve the emote stats for
* @param since Emote stats should be younger than this {@link Instant}. Only the date portion is considered.
* @return An {@link EmoteStatsModel} containing the statistics split by animated and static {@link net.dv8tion.jda.api.entities.Emote}
* @return An {@link EmoteStatsModel} containing the statistics split by animated and static emote
*/
EmoteStatsModel getEmoteStatsForServerSince(AServer server, Instant since);
@@ -25,7 +25,7 @@ public interface UsedEmoteService {
* This {@link EmoteStatsModel} will contain only deleted {@link TrackedEmote} from the server
* @param server The {@link AServer} to retrieve the emote stats for
* @param since Emote stats should be younger than this {@link Instant}. Only the date portion is considered.
* @return An {@link EmoteStatsModel} containing the statistics split by animated and static {@link net.dv8tion.jda.api.entities.Emote}
* @return An {@link EmoteStatsModel} containing the statistics split by animated and static emote
*/
EmoteStatsModel getDeletedEmoteStatsForServerSince(AServer server, Instant since);
@@ -34,7 +34,7 @@ public interface UsedEmoteService {
* This {@link EmoteStatsModel} will contain only external {@link TrackedEmote} from the server
* @param server The {@link AServer} to retrieve the emote stats for
* @param since Emote stats should be younger than this {@link Instant}. Only the date portion is considered.
* @return An {@link EmoteStatsModel} containing the statistics split by animated and static {@link net.dv8tion.jda.api.entities.Emote}
* @return An {@link EmoteStatsModel} containing the statistics split by animated and static emote
*/
EmoteStatsModel getExternalEmoteStatsForServerSince(AServer server, Instant since);
@@ -44,7 +44,7 @@ public interface UsedEmoteService {
* the {@link net.dv8tion.jda.api.entities.Guild}
* @param server The {@link AServer} to retrieve the emote stats for
* @param since Emote stats should be younger than this {@link Instant}. Only the date portion is considered.
* @return An {@link EmoteStatsModel} containing the statistics split by animated and static {@link net.dv8tion.jda.api.entities.Emote}
* @return An {@link EmoteStatsModel} containing the statistics split by animated and static emote
*/
EmoteStatsModel getActiveEmoteStatsForServerSince(AServer server, Instant since);
EmoteStatsResultDisplay getEmoteStatForEmote(TrackedEmote trackedEmote, Instant since);