[AB-xx] fixing javadoc

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

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;
}

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;

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);