Skip to content

Commit b1b4dc2

Browse files
Andre601Andre601
committed
More Javadoc corrections
1 parent 9c00593 commit b1b4dc2

File tree

3 files changed

+16
-13
lines changed

3 files changed

+16
-13
lines changed

‎javacord/src/main/java/org/botblock/javabotblockapi/javacord/PostAction.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,8 @@ public void disableAutoPost(long time, @Nonnull TimeUnit timeUnit){
147147
/**
148148
* Starts a {@link java.util.concurrent.ScheduledExecutorService#scheduleAtFixedRate(Runnable, long, long, TimeUnit) scheduleAtFixedRate}
149149
* task, which will post the statistics of the provided {@link org.javacord.api.DiscordApi DiscordApi instance} every n minutes.
150-
*
151-
* <p>If the post can't be performed - either by getting a {@link RateLimitedException RateLimitedException}
150+
*
151+
* <p>If the post can't be performed - either by getting a {@link org.botblock.javabotblockapi.core.exceptions.RateLimitedException RatelimitedException}
152152
* or by getting an {@link java.io.IOException IOException} - will the exception be caught and a Stacktrace printed.
153153
*
154154
* <p>The scheduler will wait an initial delay of 1 minute and then performs a task every n minutes, where n is the
@@ -196,7 +196,7 @@ public void enableAutoPost(@Nonnull BotBlockAPI botBlockAPI, @Nonnull DiscordApi
196196
*
197197
* @throws java.io.IOException
198198
* When the POST request wasn't successful.
199-
* @throws RateLimitedException
199+
* @throws org.botblock.javabotblockapi.core.exceptions.RateLimitedException
200200
* When we get rate limited by the BotBlock API (returns error code 429).
201201
*/
202202
public void postGuilds(@Nonnull BotBlockAPI botBlockAPI, @Nonnull DiscordApi... discordApis) throws IOException, RateLimitedException{

‎jda/src/main/java/org/botblock/javabotblockapi/jda/PostAction.java‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ public void disableAutoPost(long time, @Nonnull TimeUnit timeUnit){
167167
* Starts a {@link java.util.concurrent.ScheduledExecutorService#scheduleAtFixedRate(Runnable, long, long, TimeUnit) scheduleAtFixedRate}
168168
* task, which will post the statistics of the provided {@link net.dv8tion.jda.api.JDA JDA instance} every n minutes.
169169
*
170-
* <p>If the post can't be performed - either by getting a {@link RateLimitedException RatelimitedException}
170+
* <p>If the post can't be performed - either by getting a {@link org.botblock.javabotblockapi.core.exceptions.RateLimitedException RatelimitedException}
171171
* or by getting an {@link java.io.IOException IOException} - will the exception be catched and the stacktrace printed.
172172
*
173173
* <p>The scheduler will wait an initial delay of 1 minute and then performs a task every n minutes, where n is the
@@ -195,7 +195,7 @@ public void enableAutoPost(@Nonnull JDA jda, @Nonnull BotBlockAPI botBlockAPI){
195195
* Starts a {@link java.util.concurrent.ScheduledExecutorService#scheduleAtFixedRate(Runnable, long, long, TimeUnit) scheduleAtFixedRate}
196196
* task, which will post the statistics of the provided {@link net.dv8tion.jda.api.sharding.ShardManager ShardManager instance} every n minutes.
197197
*
198-
* <p>If the post can't be performed - either by getting a {@link RateLimitedException RatelimitedException}
198+
* <p>If the post can't be performed - either by getting a {@link org.botblock.javabotblockapi.core.exceptions.RateLimitedException RatelimitedException}
199199
* or by getting an {@link java.io.IOException IOException} - will the exception be caught and a Stacktrace printed.
200200
*
201201
* <p>The scheduler will wait an initial delay of 1 minute and then performs a task every n minutes, where n is the
@@ -231,7 +231,7 @@ public void enableAutoPost(@Nonnull ShardManager shardManager, @Nonnull BotBlock
231231
*
232232
* @throws java.io.IOException
233233
* When the POST request wasn't successful.
234-
* @throws RateLimitedException
234+
* @throws org.botblock.javabotblockapi.core.exceptions.RateLimitedException
235235
* When we get rate limited by the BotBlock API (returns error code 429).
236236
*/
237237
public void postGuilds(@Nonnull JDA jda, @Nonnull BotBlockAPI botBlockAPI) throws IOException, RateLimitedException{
@@ -252,16 +252,19 @@ public void postGuilds(@Nonnull JDA jda, @Nonnull BotBlockAPI botBlockAPI) throw
252252
* Performs a POST request towards the BotBlock API using the information from the provided
253253
* {@link net.dv8tion.jda.api.sharding.ShardManager ShardManager} and {@link org.botblock.javabotblockapi.core.BotBlockAPI BotBlockAPI} instances.
254254
*
255+
* <p>The following Exceptions may be thrown by the {@link org.botblock.javabotblockapi.core.CheckUtil CheckUtil}:
256+
* <ul>
257+
* <li>{@link java.lang.IllegalStateException IllegalStateException} - if the first shard of the provided ShardManager is null.</li>
258+
* </ul>
259+
*
255260
* @param shardManager
256261
* The {@link net.dv8tion.jda.api.sharding.ShardManager ShardManager instance} to post stats from.
257262
* @param botBlockAPI
258263
* The {@link org.botblock.javabotblockapi.core.BotBlockAPI BotBlockAPI instance} to use.
259264
*
260-
* @throws java.lang.IllegalStateException
261-
* When the first shard (id 0) of the provided ShardManager is null.
262265
* @throws java.io.IOException
263266
* When the POST request wasn't successful.
264-
* @throws RateLimitedException
267+
* @throws org.botblock.javabotblockapi.core.exceptions.RateLimitedException
265268
* When we get rate limited by the BotBlock API (returns error code 429).
266269
*/
267270
public void postGuilds(@Nonnull ShardManager shardManager, @Nonnull BotBlockAPI botBlockAPI) throws IOException, RateLimitedException{

‎request/src/main/java/org/botblock/javabotblockapi/requests/PostAction.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ public void disableAutoPost(long time, @Nonnull TimeUnit timeUnit){
162162
* Starts a {@link java.util.concurrent.ScheduledExecutorService#scheduleAtFixedRate(Runnable, long, long, TimeUnit) scheduleAtFixedRate}
163163
* task, which will post the provided guild count to the provided bot lists every n minutes.
164164
*
165-
* <p>If the post can't be performed - either by getting a {@link RateLimitedException RatelimitedException}
165+
* <p>If the post can't be performed - either by getting a {@link org.botblock.javabotblockapi.core.exceptions.RateLimitedException RatelimitedException}
166166
* or by getting an {@link java.io.IOException IOException} - will the exception be catched and the stacktrace printed.
167167
* <br>The scheduler may be canceled by this.
168168
*
@@ -191,7 +191,7 @@ public void enableAutoPost(@Nonnull Long botId, int guilds, @Nonnull BotBlockAPI
191191
* Starts a {@link java.util.concurrent.ScheduledExecutorService#scheduleAtFixedRate(Runnable, long, long, TimeUnit) scheduleAtFixedRate}
192192
* task, which will post the provided guild count to the provided bot lists every n minutes.
193193
*
194-
* <p>If the post can't be performed - either by getting a {@link RateLimitedException RatelimitedException}
194+
* <p>If the post can't be performed - either by getting a {@link org.botblock.javabotblockapi.core.exceptions.RateLimitedException RatelimitedException}
195195
* or by getting an {@link java.io.IOException IOException} - will the exception be catched and the stacktrace printed.
196196
* <br>The scheduler may be canceled by this.
197197
*
@@ -228,7 +228,7 @@ public void enableAutoPost(@Nonnull String botId, int guilds, @Nonnull BotBlockA
228228
*
229229
* @throws java.io.IOException
230230
* When the post request couldn't be performed.
231-
* @throws RateLimitedException
231+
* @throws org.botblock.javabotblockapi.core.exceptions.RateLimitedException
232232
* When we exceed the rate-limit of the BotBlock API.
233233
*/
234234
public void postGuilds(@Nonnull Long botId, int guilds, @Nonnull BotBlockAPI botBlockAPI) throws IOException, RateLimitedException{
@@ -252,7 +252,7 @@ public void postGuilds(@Nonnull Long botId, int guilds, @Nonnull BotBlockAPI bot
252252
*
253253
* @throws java.io.IOException
254254
* When the post request couldn't be performed.
255-
* @throws RateLimitedException
255+
* @throws org.botblock.javabotblockapi.core.exceptions.RateLimitedException
256256
* When we exceed the rate-limit of the BotBlock API.
257257
*/
258258
public void postGuilds(@Nonnull String botId, int guilds, @Nonnull BotBlockAPI botBlockAPI) throws IOException, RateLimitedException{

0 commit comments

Comments
 (0)