Version 6.4.1

- Site updated:
  - Added BOTS_DISTOP_XYZ
- Exclude CheckUtil from Javadoc
- Updated Javadoc comments
- Update main docs page
- Use GH-Pages action and gh-pages branch

Author: Andre601

.github/workflows/release_actions.yml

@@ -21,13 +21,10 @@ jobs:
     - name: Generate Javadoc
       run: ./gradlew javadoc
     - name: Push changes
-      run: |
-        git config --global user.name "github-actions[bot]"
-        git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
-        
-        git add docs
-        git commit -m "Update Javadoc (${GITHUB_SHA:0:7})"
-        git push
+      uses: peaceiris/action-gh-pages@v3
+      with: 
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs
   publish:
     needs: [generateJavadoc]
     if: success()

build.gradle

@@ -8,7 +8,7 @@ plugins{
     id 'com.github.johnrengelman.shadow' version '5.2.0'
 }
 
-def ver = new Version(major: 6, minor: 4, patch: 0)
+def ver = new Version(major: 6, minor: 4, patch: 1)
 
 allprojects {
     apply plugin: 'com.jfrog.bintray'

core/build.gradle

@@ -1,3 +1,7 @@
 /*
  * This module surprisingly enough doesn't have any dependencies whe have to implement, so this build.gradle is empty...
  */
+
+javadoc{
+    exclude "org/botblock/javabotblockAPI/core/CheckUtil.java"
+}

core/src/main/java/org/botblock/javabotblockapi/core/BotBlockAPI.java

@@ -69,12 +69,12 @@ public Builder(){}
          * <br>Entries with the same key will be overwritten.
          *
          * @param  site
-         *         The {@link Site Site} to get the name from.
+         *         The {@link org.botblock.javabotblockapi.core.Site Site} to get the name from.
          * @param  token
          *         The API token from the corresponding bot list. May not be null or empty.
          *         <br>You may receive the API token from the bot list.
          *
-         * <p>Following Exceptions can be thrown from the {@link org.botblock.javabotblockapi.core.CheckUtil CheckUtil}:
+         * <p>Following Exceptions can be thrown from the CheckUtil:
          * <ul>
          *     <li>{@link java.lang.NullPointerException NullPointerException} - When the provided Token is empty.</li>
          *     <li>{@link java.lang.IllegalStateException IllegalStateException} - When the provided Site doesn't support POST requests.</li>
@@ -103,7 +103,7 @@ public Builder addAuthToken(@Nonnull Site site, @Nonnull String token){
          *         The API token from the corresponding bot list. May not be null or empty.
          *         <br>You may receive the API token from the bot list.
          *
-         * <p>Following Exceptions can be thrown from the {@link org.botblock.javabotblockapi.core.CheckUtil CheckUtil}:
+         * <p>Following Exceptions can be thrown from the CheckUtil:
          * <ul>
          *     <li>{@link java.lang.NullPointerException NullPointerException} - When the provided Site or Token is empty.</li>
          * </ul>
@@ -125,7 +125,7 @@ public Builder addAuthToken(@Nonnull String site, @Nonnull String token){
          * @param  tokens
          *         The Map that should be used. May not be null.
          *
-         * <p>Following Exceptions can be thrown from the {@link org.botblock.javabotblockapi.core.CheckUtil CheckUtil}:
+         * <p>Following Exceptions can be thrown from the CheckUtil:
          * <ul>
          *     <li>{@link java.lang.NullPointerException NullPointerException} - When the provided Token is empty.</li>
          * </ul>
@@ -146,7 +146,7 @@ public Builder setAuthTokens(@Nonnull Map<String, String> tokens){
          * @param  updateDelay
          *         The update interval in minutes that should be used. This can't be less than 2.
          *
-         * <p>Following Exceptions can be thrown from the {@link org.botblock.javabotblockapi.core.CheckUtil CheckUtil}:
+         * <p>Following Exceptions can be thrown from the CheckUtil:
          * <ul>
          *     <li>{@link java.lang.IllegalStateException IllegalStateException} - When the provided interval is less than 2.</li>
          * </ul>
@@ -163,7 +163,7 @@ public Builder setUpdateDelay(@Nonnull Integer updateDelay){
         /**
          * Builds the instance of {@link org.botblock.javabotblockapi.core.BotBlockAPI BotBlockAPI}.
          *
-         * <p>Following Exceptions can be thrown from the {@link org.botblock.javabotblockapi.core.CheckUtil CheckUtil}:
+         * <p>Following Exceptions can be thrown from the CheckUtil:
          * <ul>
          *     <li>{@link java.lang.NullPointerException NullPointerException} - When the Tokens Map is empty.</li>
          * </ul>

core/src/main/java/org/botblock/javabotblockapi/core/CheckUtil.java

@@ -20,45 +20,18 @@
 
 import java.util.Map;
 
-/**
- * Utility class to perform basic checks.
- */
 public class CheckUtil{
 
-    /**
-     * Will throw a {@link java.lang.NullPointerException NullPointerException} when the provided String is empty.
-     * 
-     * @param value
-     *        The String to check.
-     * @param name
-     *        The name of the parameter checked.
-     */
     public static void notEmpty(String value, String name){
         if(value.isEmpty())
             throw new NullPointerException(name + " may not be empty.");
     }
 
-    /**
-     * Will throw a {@link java.lang.NullPointerException NullPointerException} when the provided Map is empty.
-     * 
-     * @param value
-     *        The Map to check.
-     * @param name
-     *        The name of the parameter checked.
-     */
     public static void notEmpty(Map<?, ?> value, String name){
         if(value.isEmpty())
             throw new NullPointerException(name + " may not be empty.");
     }
 
-    /**
-     * Will throw a {@link java.lang.IllegalStateException IllegalStateException} when the provided expression returns true.
-     * 
-     * @param expression
-     *        The expression to check against.
-     * @param message
-     *        The message to print in the Exception when thrown.
-     */
     public static void condition(boolean expression, String message){
         if(expression)
             throw new IllegalStateException(message);

core/src/main/java/org/botblock/javabotblockapi/core/JavaBotBlockAPIInfo.java

@@ -22,6 +22,8 @@
  * Class containing static info used in other modules.
  * <br>Feel free to use the info shared here inside your bot if you, for example, want to share what Lib your bot
  * uses to post Guild count or similar.
+ * 
+ * @since 6.4.0
  */
 public class JavaBotBlockAPIInfo{
 
@@ -36,7 +38,7 @@ public class JavaBotBlockAPIInfo{
     /**
      * Patch version of the Wrapper.
      */
-    public static final String PATCH = "0";
+    public static final String PATCH = "1";
 
     /**
      * Full version in the format {@code major.minor.patch}.