diff --git a/build.gradle.kts b/build.gradle.kts index 3f22f38721..3eab64e64b 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -261,7 +261,7 @@ javadoc.apply { opt.links( "https://docs.oracle.com/javase/8/docs/api/", "https://takahikokawasaki.github.io/nv-websocket-client/", - "https://square.github.io/okhttp/3.x/okhttp/") + "https://javadoc.io/doc/com.squareup.okhttp3/okhttp/3.13.0/") if (JavaVersion.VERSION_1_8 < javaVersion) { opt.addBooleanOption("html5", true) // Adds search bar opt.addStringOption("-release", "8") @@ -270,6 +270,14 @@ javadoc.apply { if (javaVersion in JavaVersion.VERSION_11..JavaVersion.VERSION_12) { opt.addBooleanOption("-no-module-directories", true) } + // Java 13 changed accessibility rules. + // On versions less than Java 13, we simply ignore the errors. + // Both of these remove "no comment" warnings. + if (javaVersion >= JavaVersion.VERSION_13) { + opt.addBooleanOption("Xdoclint:all,-missing", true) + } else { + opt.addBooleanOption("Xdoclint:all,-missing,-accessibility", true) + } } dependsOn(sourcesJar) diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 0d4a951687..7454180f2a 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index e750102e09..2e6e5897b5 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-7.3-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew index cccdd3d517..1b6c787337 100755 --- a/gradlew +++ b/gradlew @@ -1,78 +1,129 @@ -#!/usr/bin/env sh +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# ############################################################################## -## -## Gradle start up script for UN*X -## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# ############################################################################## # Attempt to set APP_HOME + # Resolve links: $0 may be a link -PRG="$0" -# Need this for relative symlinks. -while [ -h "$PRG" ] ; do - ls=`ls -ld "$PRG"` - link=`expr "$ls" : '.*-> \(.*\)$'` - if expr "$link" : '/.*' > /dev/null; then - PRG="$link" - else - PRG=`dirname "$PRG"`"/$link" - fi +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac done -SAVED="`pwd`" -cd "`dirname \"$PRG\"`/" >/dev/null -APP_HOME="`pwd -P`" -cd "$SAVED" >/dev/null + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit APP_NAME="Gradle" -APP_BASE_NAME=`basename "$0"` +APP_BASE_NAME=${0##*/} # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS="" +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' # Use the maximum available, or set MAX_FD != -1 to use that value. -MAX_FD="maximum" +MAX_FD=maximum warn () { echo "$*" -} +} >&2 die () { echo echo "$*" echo exit 1 -} +} >&2 # OS specific support (must be 'true' or 'false'). cygwin=false msys=false darwin=false nonstop=false -case "`uname`" in - CYGWIN* ) - cygwin=true - ;; - Darwin* ) - darwin=true - ;; - MINGW* ) - msys=true - ;; - NONSTOP* ) - nonstop=true - ;; +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; esac CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + # Determine the Java command to use to start the JVM. if [ -n "$JAVA_HOME" ] ; then if [ -x "$JAVA_HOME/jre/sh/java" ] ; then # IBM's JDK on AIX uses strange locations for the executables - JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACMD=$JAVA_HOME/jre/sh/java else - JAVACMD="$JAVA_HOME/bin/java" + JAVACMD=$JAVA_HOME/bin/java fi if [ ! -x "$JAVACMD" ] ; then die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME @@ -81,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the location of your Java installation." fi else - JAVACMD="java" + JAVACMD=java which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. Please set the JAVA_HOME variable in your environment to match the @@ -89,84 +140,95 @@ location of your Java installation." fi # Increase the maximum file descriptors if we can. -if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then - MAX_FD_LIMIT=`ulimit -H -n` - if [ $? -eq 0 ] ; then - if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then - MAX_FD="$MAX_FD_LIMIT" - fi - ulimit -n $MAX_FD - if [ $? -ne 0 ] ; then - warn "Could not set maximum file descriptor limit: $MAX_FD" - fi - else - warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" - fi +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac fi -# For Darwin, add options to specify how the application appears in the dock -if $darwin; then - GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" -fi +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) -# For Cygwin, switch paths to Windows format before running java -if $cygwin ; then - APP_HOME=`cygpath --path --mixed "$APP_HOME"` - CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` - JAVACMD=`cygpath --unix "$JAVACMD"` - - # We build the pattern for arguments to be converted via cygpath - ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` - SEP="" - for dir in $ROOTDIRSRAW ; do - ROOTDIRS="$ROOTDIRS$SEP$dir" - SEP="|" - done - OURCYGPATTERN="(^($ROOTDIRS))" - # Add a user-defined pattern to the cygpath arguments - if [ "$GRADLE_CYGPATTERN" != "" ] ; then - OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" - fi # Now convert the arguments - kludge to limit ourselves to /bin/sh - i=0 - for arg in "$@" ; do - CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` - CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option - - if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition - eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` - else - eval `echo args$i`="\"$arg\"" + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) fi - i=$((i+1)) + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg done - case $i in - (0) set -- ;; - (1) set -- "$args0" ;; - (2) set -- "$args0" "$args1" ;; - (3) set -- "$args0" "$args1" "$args2" ;; - (4) set -- "$args0" "$args1" "$args2" "$args3" ;; - (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; - (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; - (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; - (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; - (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; - esac fi -# Escape application args -save () { - for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done - echo " " -} -APP_ARGS=$(save "$@") - -# Collect all arguments for the java command, following the shell quoting and substitution rules -eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" - -# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong -if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then - cd "$(dirname "$0")" -fi +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat index f9553162f1..107acd32c4 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,3 +1,19 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + @if "%DEBUG%" == "" @echo off @rem ########################################################################## @rem @@ -13,15 +29,18 @@ if "%DIRNAME%" == "" set DIRNAME=. set APP_BASE_NAME=%~n0 set APP_HOME=%DIRNAME% +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS= +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" @rem Find java.exe if defined JAVA_HOME goto findJavaFromJavaHome set JAVA_EXE=java.exe %JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init +if "%ERRORLEVEL%" == "0" goto execute echo. echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. @@ -35,7 +54,7 @@ goto fail set JAVA_HOME=%JAVA_HOME:"=% set JAVA_EXE=%JAVA_HOME%/bin/java.exe -if exist "%JAVA_EXE%" goto init +if exist "%JAVA_EXE%" goto execute echo. echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% @@ -45,28 +64,14 @@ echo location of your Java installation. goto fail -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - :execute @rem Setup the command line set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + @rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* :end @rem End local scope for the variables with windows NT shell diff --git a/src/main/java/net/dv8tion/jda/api/JDA.java b/src/main/java/net/dv8tion/jda/api/JDA.java index 710dbba673..a602aadf56 100644 --- a/src/main/java/net/dv8tion/jda/api/JDA.java +++ b/src/main/java/net/dv8tion/jda/api/JDA.java @@ -208,7 +208,7 @@ public boolean equals(Object o) /** * The {@link GatewayIntent GatewayIntents} for this JDA session. - * + * * @return {@link EnumSet} of active gateway intents */ @Nonnull @@ -255,7 +255,7 @@ public boolean equals(Object o) * The time in milliseconds that discord took to respond to a REST request. *
This will request the current user from the API and calculate the time the response took. * - *

Example

+ *

Example

*

      * jda.getRestPing().queue( (time) {@literal ->}
      *     channel.sendMessageFormat("Ping: %d ms", time).queue()
@@ -285,7 +285,7 @@ default RestAction getRestPing()
     /**
      * This method will block until JDA has reached the specified connection status.
      *
-     * 

Login Cycle

+ *

Login Cycle

*
    *
  1. {@link net.dv8tion.jda.api.JDA.Status#INITIALIZING INITIALIZING}
  2. *
  3. {@link net.dv8tion.jda.api.JDA.Status#INITIALIZED INITIALIZED}
  4. @@ -321,7 +321,7 @@ default JDA awaitStatus(@Nonnull JDA.Status status) throws InterruptedException /** * This method will block until JDA has reached the specified connection status. * - *

    Login Cycle

    + *

    Login Cycle

    *
      *
    1. {@link net.dv8tion.jda.api.JDA.Status#INITIALIZING INITIALIZING}
    2. *
    3. {@link net.dv8tion.jda.api.JDA.Status#INITIALIZED INITIALIZED}
    4. @@ -612,7 +612,7 @@ default CommandCreateAction upsertCommand(@Nonnull String name, @Nonnull String *

      Global commands can take up to 1 hour to propagate to the clients. * For testing, it is recommended to use a test guild with guild commands. * - *

      Examples

      + *

      Examples

      *
      {@code
            * // Set list to 2 commands
            * jda.updateCommands()
      @@ -1379,7 +1379,7 @@ default PrivateChannel getPrivateChannelById(long id)
            * 
      This will fail with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_USER UNKNOWN_USER} * if the user does not exist. * - *

      Example

      + *

      Example

      *
      {@code
            * public void sendMessage(JDA jda, long userId, String content) {
            *     jda.openPrivateChannelById(userId)
      @@ -1407,7 +1407,7 @@ default PrivateChannel getPrivateChannelById(long id)
            * 
      This will fail with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_USER UNKNOWN_USER} * if the user does not exist. * - *

      Example

      + *

      Example

      *
      {@code
            * public void sendMessage(JDA jda, String userId, String content) {
            *     jda.openPrivateChannelById(userId)
      diff --git a/src/main/java/net/dv8tion/jda/api/JDABuilder.java b/src/main/java/net/dv8tion/jda/api/JDABuilder.java
      index 7ed38aecbe..2ed8550360 100644
      --- a/src/main/java/net/dv8tion/jda/api/JDABuilder.java
      +++ b/src/main/java/net/dv8tion/jda/api/JDABuilder.java
      @@ -137,7 +137,7 @@ public static JDABuilder createDefault(@Nullable String token)
            *
            * 

      You can omit intents in this method to use {@link GatewayIntent#DEFAULT} and enable additional intents with * {@link #enableIntents(Collection)}. - * + * *

      If you don't enable certain intents, the cache will be disabled. * For instance, if the {@link GatewayIntent#GUILD_MEMBERS GUILD_MEMBERS} intent is disabled, then members will only * be cached when a voice state is available. @@ -557,7 +557,7 @@ public JDABuilder setRelativeRateLimit(boolean enable) * * @return The JDABuilder instance. Useful for chaining. * - * @see #enableCache(CacheFlag, CacheFlag...) + * @see #enableCache(CacheFlag, CacheFlag...) * @see #disableCache(Collection) */ @Nonnull @@ -582,7 +582,7 @@ public JDABuilder enableCache(@Nonnull Collection flags) * * @return The JDABuilder instance. Useful for chaining. * - * @see #enableCache(Collection) + * @see #enableCache(Collection) * @see #disableCache(CacheFlag, CacheFlag...) */ @Nonnull @@ -606,7 +606,7 @@ public JDABuilder enableCache(@Nonnull CacheFlag flag, @Nonnull CacheFlag... fla * * @return The JDABuilder instance. Useful for chaining. * - * @see #disableCache(CacheFlag, CacheFlag...) + * @see #disableCache(CacheFlag, CacheFlag...) * @see #enableCache(Collection) */ @Nonnull @@ -632,7 +632,7 @@ public JDABuilder disableCache(@Nonnull Collection flags) * * @return The JDABuilder instance. Useful for chaining. * - * @see #disableCache(Collection) + * @see #disableCache(Collection) * @see #enableCache(CacheFlag, CacheFlag...) */ @Nonnull @@ -652,7 +652,7 @@ public JDABuilder disableCache(@Nonnull CacheFlag flag, @Nonnull CacheFlag... fl *

      It is not recommended to disable {@link GatewayIntent#GUILD_MEMBERS GatewayIntent.GUILD_MEMBERS} when * using {@link MemberCachePolicy#ALL MemberCachePolicy.ALL} as the members cannot be removed from cache by a leave event without this intent. * - *

      Example

      + *

      Example

      *
      {@code
            * public void configureCache(JDABuilder builder) {
            *     // Cache members who are in a voice channel
      @@ -782,7 +782,7 @@ public JDABuilder setRequestTimeoutRetry(boolean retryOnTimeout)
            * Sets the token that will be used by the {@link net.dv8tion.jda.api.JDA} instance to log in when
            * {@link net.dv8tion.jda.api.JDABuilder#build() build()} is called.
            *
      -     * 

      For {@link net.dv8tion.jda.api.AccountType#BOT}

      + *

      For {@link net.dv8tion.jda.api.AccountType#BOT}

      *
        *
      1. Go to your Discord Applications
      2. *
      3. Create or select an already existing application
      4. diff --git a/src/main/java/net/dv8tion/jda/api/audit/ActionType.java b/src/main/java/net/dv8tion/jda/api/audit/ActionType.java index 86c279c830..99d75be053 100644 --- a/src/main/java/net/dv8tion/jda/api/audit/ActionType.java +++ b/src/main/java/net/dv8tion/jda/api/audit/ActionType.java @@ -28,7 +28,7 @@ public enum ActionType /** * An Administrator updated {@link net.dv8tion.jda.api.entities.Guild Guild} information. * - *

        Possible Keys

        + *

        Possible Keys

        *
          *
        • {@link net.dv8tion.jda.api.audit.AuditLogKey#GUILD_AFK_CHANNEL GUILD_AFK_CHANNEL}
        • *
        • {@link net.dv8tion.jda.api.audit.AuditLogKey#GUILD_AFK_TIMEOUT GUILD_AFK_TIMEOUT}
        • @@ -51,7 +51,7 @@ public enum ActionType /** * An Administrator created a {@link GuildChannel GuildChannel} * - *

          Possible Keys

          + *

          Possible Keys

          *
            *
          • {@link net.dv8tion.jda.api.audit.AuditLogKey#CHANNEL_BITRATE CHANNEL_BITRATE} (VoiceChannel only)
          • *
          • {@link net.dv8tion.jda.api.audit.AuditLogKey#CHANNEL_USER_LIMIT CHANNEL_USER_LIMIT} (VoiceChannel only)
          • @@ -69,7 +69,7 @@ public enum ActionType /** * An Administrator updated {@link GuildChannel GuildChannel} information. * - *

            Possible Keys

            + *

            Possible Keys

            *
              *
            • {@link net.dv8tion.jda.api.audit.AuditLogKey#CHANNEL_BITRATE CHANNEL_BITRATE} (VoiceChannel only)
            • *
            • {@link net.dv8tion.jda.api.audit.AuditLogKey#CHANNEL_USER_LIMIT CHANNEL_USER_LIMIT} (VoiceChannel only)
            • @@ -85,7 +85,7 @@ public enum ActionType /** * An Administrator deleted a {@link GuildChannel GuildChannel}. * - *

              Possible Keys

              + *

              Possible Keys

              *
                *
              • {@link net.dv8tion.jda.api.audit.AuditLogKey#CHANNEL_BITRATE CHANNEL_BITRATE} (VoiceChannel only)
              • *
              • {@link net.dv8tion.jda.api.audit.AuditLogKey#CHANNEL_USER_LIMIT CHANNEL_USER_LIMIT} (VoiceChannel only)
              • @@ -103,7 +103,7 @@ public enum ActionType /** * An Administrator created a {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}. * - *

                Possible Keys

                + *

                Possible Keys

                *
                  *
                • {@link net.dv8tion.jda.api.audit.AuditLogKey#OVERRIDE_ALLOW OVERRIDE_ALLOW}
                • *
                • {@link net.dv8tion.jda.api.audit.AuditLogKey#OVERRIDE_DENY OVERRIDE_DENY}
                • @@ -111,7 +111,7 @@ public enum ActionType *
                • {@link net.dv8tion.jda.api.audit.AuditLogKey#ID ID}
                • *
                * - *

                Possible Options

                + *

                Possible Options

                *
                  *
                • {@link net.dv8tion.jda.api.audit.AuditLogOption#ROLE ROLE}
                • *
                • {@link net.dv8tion.jda.api.audit.AuditLogOption#USER USER}
                • @@ -122,7 +122,7 @@ public enum ActionType /** * An Administrator updated {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride} information. * - *

                  Possible Keys

                  + *

                  Possible Keys

                  *
                    *
                  • {@link net.dv8tion.jda.api.audit.AuditLogKey#OVERRIDE_ALLOW OVERRIDE_ALLOW}
                  • *
                  • {@link net.dv8tion.jda.api.audit.AuditLogKey#OVERRIDE_DENY OVERRIDE_DENY}
                  • @@ -133,7 +133,7 @@ public enum ActionType /** * An Administrator deleted a {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}. * - *

                    Possible Keys

                    + *

                    Possible Keys

                    *
                      *
                    • {@link net.dv8tion.jda.api.audit.AuditLogKey#OVERRIDE_ALLOW OVERRIDE_ALLOW}
                    • *
                    • {@link net.dv8tion.jda.api.audit.AuditLogKey#OVERRIDE_DENY OVERRIDE_DENY}
                    • @@ -141,7 +141,7 @@ public enum ActionType *
                    • {@link net.dv8tion.jda.api.audit.AuditLogKey#ID ID}
                    • *
                    * - *

                    Possible Options

                    + *

                    Possible Options

                    *
                      *
                    • {@link net.dv8tion.jda.api.audit.AuditLogOption#ROLE ROLE}
                    • *
                    • {@link net.dv8tion.jda.api.audit.AuditLogOption#USER USER}
                    • @@ -158,7 +158,7 @@ public enum ActionType /** * An Administrator has pruned members for inactivity. * - *

                      Possible Options

                      + *

                      Possible Options

                      *
                        *
                      • {@link net.dv8tion.jda.api.audit.AuditLogOption#DELETE_MEMBER_DAYS DELETE_MEMBER_DAYS}
                      • *
                      • {@link net.dv8tion.jda.api.audit.AuditLogOption#MEMBERS_REMOVED MEMBERS_REMOVED}
                      • @@ -181,7 +181,7 @@ public enum ActionType * A {@link net.dv8tion.jda.api.entities.Member Member} was either updated by an administrator or * the member updated itself. * - *

                        Possible Keys

                        + *

                        Possible Keys

                        *
                          *
                        • {@link net.dv8tion.jda.api.audit.AuditLogKey#MEMBER_NICK MEMBER_NICK}
                        • *
                        @@ -191,7 +191,7 @@ public enum ActionType /** * An Administrator updated the roles of a member. * - *

                        Possible Keys

                        + *

                        Possible Keys

                        *
                          *
                        • {@link net.dv8tion.jda.api.audit.AuditLogKey#MEMBER_ROLES_ADD MEMBER_ROLES_ADD}
                        • *
                        • {@link net.dv8tion.jda.api.audit.AuditLogKey#MEMBER_ROLES_REMOVE MEMBER_ROLES_REMOVE}
                        • @@ -202,7 +202,7 @@ public enum ActionType /** * One or more members were moved from one voice channel to another by an Administrator * - *

                          Possible Options

                          + *

                          Possible Options

                          *
                            *
                          • {@link AuditLogOption#COUNT} The amount of users moved
                          • *
                          • {@link AuditLogOption#CHANNEL} The target channel
                          • @@ -213,7 +213,7 @@ public enum ActionType /** * One or more members were disconnected from a voice channel by an Administrator * - *

                            Possible Options

                            + *

                            Possible Options

                            *
                              *
                            • {@link AuditLogOption#COUNT} The amount of users who were disconnected
                            • *
                            @@ -229,7 +229,7 @@ public enum ActionType /** * An Administrator has created a {@link net.dv8tion.jda.api.entities.Role Role}. * - *

                            Possible Keys

                            + *

                            Possible Keys

                            *
                              *
                            • {@link net.dv8tion.jda.api.audit.AuditLogKey#ROLE_COLOR ROLE_COLOR}
                            • *
                            • {@link net.dv8tion.jda.api.audit.AuditLogKey#ROLE_HOISTED ROLE_HOISTED}
                            • @@ -244,7 +244,7 @@ public enum ActionType /** * An Administrator has updated a {@link net.dv8tion.jda.api.entities.Role Role}. * - *

                              Possible Keys

                              + *

                              Possible Keys

                              *
                                *
                              • {@link net.dv8tion.jda.api.audit.AuditLogKey#ROLE_COLOR ROLE_COLOR}
                              • *
                              • {@link net.dv8tion.jda.api.audit.AuditLogKey#ROLE_HOISTED ROLE_HOISTED}
                              • @@ -258,7 +258,7 @@ public enum ActionType /** * An Administrator has deleted a {@link net.dv8tion.jda.api.entities.Role Role}. * - *

                                Possible Keys

                                + *

                                Possible Keys

                                *
                                  *
                                • {@link net.dv8tion.jda.api.audit.AuditLogKey#ROLE_COLOR ROLE_COLOR}
                                • *
                                • {@link net.dv8tion.jda.api.audit.AuditLogKey#ROLE_HOISTED ROLE_HOISTED}
                                • @@ -274,7 +274,7 @@ public enum ActionType /** * Someone has created an {@link net.dv8tion.jda.api.entities.Invite Invite}. * - *

                                  Possible Keys

                                  + *

                                  Possible Keys

                                  *
                                    *
                                  • {@link net.dv8tion.jda.api.audit.AuditLogKey#INVITE_CHANNEL INVITE_CHANNEL}
                                  • *
                                  • {@link net.dv8tion.jda.api.audit.AuditLogKey#INVITE_CODE INVITE_CODE}
                                  • @@ -294,7 +294,7 @@ public enum ActionType /** * An Administrator has deleted an {@link net.dv8tion.jda.api.entities.Invite Invite}. * - *

                                    Possible Keys

                                    + *

                                    Possible Keys

                                    *
                                      *
                                    • {@link net.dv8tion.jda.api.audit.AuditLogKey#INVITE_CHANNEL INVITE_CHANNEL}
                                    • *
                                    • {@link net.dv8tion.jda.api.audit.AuditLogKey#INVITE_CODE INVITE_CODE}
                                    • @@ -310,7 +310,7 @@ public enum ActionType /** * An Administrator has created a {@link net.dv8tion.jda.api.entities.Webhook Webhook}. * - *

                                      Possible Keys

                                      + *

                                      Possible Keys

                                      *
                                        *
                                      • {@link net.dv8tion.jda.api.audit.AuditLogKey#WEBHOOK_CHANNEL WEBHOOK_CHANNEL}
                                      • *
                                      • {@link net.dv8tion.jda.api.audit.AuditLogKey#WEBHOOK_ICON WEBHOOK_ICON}
                                      • @@ -323,7 +323,7 @@ public enum ActionType /** * An Administrator has updated a {@link net.dv8tion.jda.api.entities.Webhook Webhook}. * - *

                                        Possible Keys

                                        + *

                                        Possible Keys

                                        *
                                          *
                                        • {@link net.dv8tion.jda.api.audit.AuditLogKey#WEBHOOK_CHANNEL WEBHOOK_CHANNEL}
                                        • *
                                        • {@link net.dv8tion.jda.api.audit.AuditLogKey#WEBHOOK_ICON WEBHOOK_ICON}
                                        • @@ -336,7 +336,7 @@ public enum ActionType /** * An Administrator has deleted a {@link net.dv8tion.jda.api.entities.Webhook Webhook}. * - *

                                          Possible Keys

                                          + *

                                          Possible Keys

                                          *
                                            *
                                          • {@link net.dv8tion.jda.api.audit.AuditLogKey#WEBHOOK_CHANNEL WEBHOOK_CHANNEL}
                                          • *
                                          • {@link net.dv8tion.jda.api.audit.AuditLogKey#WEBHOOK_ICON WEBHOOK_ICON}
                                          • @@ -350,7 +350,7 @@ public enum ActionType /** * An Administrator created an {@link net.dv8tion.jda.api.entities.Emote Emote}. * - *

                                            Possible Keys

                                            + *

                                            Possible Keys

                                            *
                                              *
                                            • {@link net.dv8tion.jda.api.audit.AuditLogKey#EMOTE_NAME EMOTE_NAME}
                                            • *
                                            @@ -360,7 +360,7 @@ public enum ActionType /** * An Administrator updated an {@link net.dv8tion.jda.api.entities.Emote Emote}. * - *

                                            Possible Keys

                                            + *

                                            Possible Keys

                                            *
                                              *
                                            • {@link net.dv8tion.jda.api.audit.AuditLogKey#EMOTE_NAME EMOTE_NAME}
                                            • *
                                            • {@link net.dv8tion.jda.api.audit.AuditLogKey#EMOTE_ROLES_ADD EMOTE_ROLES_ADD}
                                            • @@ -372,7 +372,7 @@ public enum ActionType /** * An Administrator deleted an {@link net.dv8tion.jda.api.entities.Emote Emote}. * - *

                                              Possible Keys

                                              + *

                                              Possible Keys

                                              *
                                                *
                                              • {@link net.dv8tion.jda.api.audit.AuditLogKey#EMOTE_NAME EMOTE_NAME}
                                              • *
                                              @@ -393,7 +393,7 @@ public enum ActionType /** * An Administrator has deleted one or more {@link net.dv8tion.jda.api.entities.Message Messages}. * - *

                                              Possible Options

                                              + *

                                              Possible Options

                                              *
                                                *
                                              • {@link net.dv8tion.jda.api.audit.AuditLogOption#COUNT COUNT}
                                              • *
                                              @@ -403,7 +403,7 @@ public enum ActionType /** * An Administrator has performed a bulk delete of messages in a channel * - *

                                              Possible Options

                                              + *

                                              Possible Options

                                              *
                                                *
                                              • {@link AuditLogOption#COUNT}
                                              • *
                                              @@ -413,7 +413,7 @@ public enum ActionType /** * An Administrator has pinned a message in the channel * - *

                                              Possible Options

                                              + *

                                              Possible Options

                                              *
                                                *
                                              • {@link AuditLogOption#CHANNEL}
                                              • *
                                              • {@link AuditLogOption#MESSAGE}
                                              • @@ -424,7 +424,7 @@ public enum ActionType /** * An Administrator has unpinned a message in the channel * - *

                                                Possible Options

                                                + *

                                                Possible Options

                                                *
                                                  *
                                                • {@link AuditLogOption#CHANNEL}
                                                • *
                                                • {@link AuditLogOption#MESSAGE}
                                                • @@ -450,12 +450,12 @@ public enum ActionType /** * A {@link net.dv8tion.jda.api.entities.StageInstance StageInstance} was started by a {@link net.dv8tion.jda.api.entities.StageChannel#isModerator(Member) Stage Moderator}. * - *

                                                  Possible Options

                                                  + *

                                                  Possible Options

                                                  *
                                                    *
                                                  • {@link net.dv8tion.jda.api.audit.AuditLogOption#CHANNEL CHANNEL}
                                                  • *
                                                  * - *

                                                  Possible Keys

                                                  + *

                                                  Possible Keys

                                                  *
                                                    *
                                                  • {@link net.dv8tion.jda.api.audit.AuditLogKey#CHANNEL_TOPIC CHANNEL_TOPIC}
                                                  • *
                                                  • {@link net.dv8tion.jda.api.audit.AuditLogKey#PRIVACY_LEVEL STAGE_INSTANCE_PRIVACY_LEVEL}
                                                  • @@ -466,12 +466,12 @@ public enum ActionType /** * A {@link net.dv8tion.jda.api.entities.StageInstance StageInstance} was updated by a {@link net.dv8tion.jda.api.entities.StageChannel#isModerator(Member) Stage Moderator}. * - *

                                                    Possible Options

                                                    + *

                                                    Possible Options

                                                    *
                                                      *
                                                    • {@link net.dv8tion.jda.api.audit.AuditLogOption#CHANNEL CHANNEL}
                                                    • *
                                                    * - *

                                                    Possible Keys

                                                    + *

                                                    Possible Keys

                                                    *
                                                      *
                                                    • {@link net.dv8tion.jda.api.audit.AuditLogKey#CHANNEL_TOPIC CHANNEL_TOPIC}
                                                    • *
                                                    • {@link net.dv8tion.jda.api.audit.AuditLogKey#PRIVACY_LEVEL STAGE_INSTANCE_PRIVACY_LEVEL}
                                                    • @@ -482,12 +482,12 @@ public enum ActionType /** * A {@link net.dv8tion.jda.api.entities.StageInstance StageInstance} was deleted by a {@link net.dv8tion.jda.api.entities.StageChannel#isModerator(Member) Stage Moderator}. * - *

                                                      Possible Options

                                                      + *

                                                      Possible Options

                                                      *
                                                        *
                                                      • {@link net.dv8tion.jda.api.audit.AuditLogOption#CHANNEL CHANNEL}
                                                      • *
                                                      * - *

                                                      Possible Keys

                                                      + *

                                                      Possible Keys

                                                      *
                                                        *
                                                      • {@link net.dv8tion.jda.api.audit.AuditLogKey#CHANNEL_TOPIC CHANNEL_TOPIC}
                                                      • *
                                                      • {@link net.dv8tion.jda.api.audit.AuditLogKey#PRIVACY_LEVEL STAGE_INSTANCE_PRIVACY_LEVEL}
                                                      • @@ -498,7 +498,7 @@ public enum ActionType /** * A user created a {@link net.dv8tion.jda.api.entities.ThreadChannel ThreadChannel} * - *

                                                        Possible Keys

                                                        + *

                                                        Possible Keys

                                                        *
                                                          *
                                                        • {@link net.dv8tion.jda.api.audit.AuditLogKey#THREAD_NAME THREAD_NAME}
                                                        • *
                                                        • {@link net.dv8tion.jda.api.audit.AuditLogKey#THREAD_SLOWMODE THREAD_SLOWMODE}
                                                        • @@ -514,7 +514,7 @@ public enum ActionType /** * A user updated a {@link net.dv8tion.jda.api.entities.ThreadChannel ThreadChannel} * - *

                                                          Possible Keys

                                                          + *

                                                          Possible Keys

                                                          *
                                                            *
                                                          • {@link net.dv8tion.jda.api.audit.AuditLogKey#THREAD_NAME THREAD_NAME}
                                                          • *
                                                          • {@link net.dv8tion.jda.api.audit.AuditLogKey#THREAD_SLOWMODE THREAD_SLOWMODE}
                                                          • diff --git a/src/main/java/net/dv8tion/jda/api/audit/ThreadLocalReason.java b/src/main/java/net/dv8tion/jda/api/audit/ThreadLocalReason.java index 81c7d9b568..26a2dc8fc7 100644 --- a/src/main/java/net/dv8tion/jda/api/audit/ThreadLocalReason.java +++ b/src/main/java/net/dv8tion/jda/api/audit/ThreadLocalReason.java @@ -28,7 +28,7 @@ * thread-local reason set through this handle. Thus audit-log reasons done by callbacks will also use the one set * from the executing thread. * - *

                                                            Example without closable

                                                            + *

                                                            Example without closable

                                                            *
                                                            
                                                              * String previousReason = ThreadLocalReason.getCurrent();
                                                              * ThreadLocalReason.setCurrent("Hello World");
                                                            @@ -44,7 +44,7 @@
                                                              * guild.kick(user).queue();
                                                              * 
                                                            * - *

                                                            Example with closable

                                                            + *

                                                            Example with closable

                                                            *
                                                            
                                                              * try (ThreadLocalReason.Closable __ = ThreadLocalReason.closable("Hello World")) {
                                                              *     guild.ban(user, 0).queue(v -> {
                                                            diff --git a/src/main/java/net/dv8tion/jda/api/entities/Emoji.java b/src/main/java/net/dv8tion/jda/api/entities/Emoji.java
                                                            index 105c5154ba..d83199569b 100644
                                                            --- a/src/main/java/net/dv8tion/jda/api/entities/Emoji.java
                                                            +++ b/src/main/java/net/dv8tion/jda/api/entities/Emoji.java
                                                            @@ -168,7 +168,7 @@ public static Emoji fromEmote(@Nonnull Emote emote)
                                                             
                                                                 /**
                                                                  * Parses the provided markdown formatting to an Emoji instance.
                                                            -     * 

                                                            Example

                                                            + *

                                                            Example

                                                            *
                                                            {@code
                                                                  * // animated custom emoji
                                                                  * parseMarkdown("");
                                                            diff --git a/src/main/java/net/dv8tion/jda/api/entities/Guild.java b/src/main/java/net/dv8tion/jda/api/entities/Guild.java
                                                            index 165c13183c..5cf3ba4242 100644
                                                            --- a/src/main/java/net/dv8tion/jda/api/entities/Guild.java
                                                            +++ b/src/main/java/net/dv8tion/jda/api/entities/Guild.java
                                                            @@ -188,7 +188,7 @@ default CommandCreateAction upsertCommand(@Nonnull String name, @Nonnull String
                                                                  *
                                                                  * 

                                                            You need the OAuth2 scope {@code "applications.commands"} in order to add commands to a guild. * - *

                                                            Examples

                                                            + *

                                                            Examples

                                                            *
                                                            {@code
                                                                  * // Set list to 2 commands
                                                                  * guild.updateCommands()
                                                            @@ -589,7 +589,7 @@ default MemberAction addMember(@Nonnull String accessToken, long userId)
                                                                 /**
                                                                  * Re-apply the {@link net.dv8tion.jda.api.utils.MemberCachePolicy MemberCachePolicy} of this session to all {@link Member Members} of this Guild.
                                                                  *
                                                            -     * 

                                                            Example

                                                            + *

                                                            Example

                                                            *
                                                            {@code
                                                                  * // Check if the members of this guild have at least 50% bots (bot collection/farm)
                                                                  * public void checkBots(Guild guild) {
                                                            @@ -2056,7 +2056,7 @@ default RestAction retrieveBan(@Nonnull User bannedUser)
                                                                  * this Guild.
                                                                  * 
                                                            This iterates from the most recent action to the first logged one. (Limit 90 days into history by discord api) * - *

                                                            Examples

                                                            + *

                                                            Examples

                                                            *
                                                            {@code
                                                                  * public void logBan(GuildBanEvent event) {
                                                                  *     Guild guild = event.getGuild();
                                                            @@ -4668,7 +4668,7 @@ default AuditableRestAction removeRoleFromMember(@Nonnull String userId, @
                                                                  * 
                                                            None of the provided roles may be the Public Role of the current Guild. *
                                                            If a role is both in {@code rolesToAdd} and {@code rolesToRemove} it will be removed. * - *

                                                            Example

                                                            + *

                                                            Example

                                                            *
                                                            {@code
                                                                  * public static void promote(Member member) {
                                                                  *     Guild guild = member.getGuild();
                                                            @@ -4679,7 +4679,7 @@ default AuditableRestAction removeRoleFromMember(@Nonnull String userId, @
                                                                  * }
                                                                  * }
                                                            * - *

                                                            Warning

                                                            + *

                                                            Warning

                                                            * This may not be used together with any other role add/remove/modify methods for the same Member * within one event listener cycle! The changes made by this require cache updates which are triggered by * lifecycle events which are received later. This may only be called again once the specific Member has been updated @@ -4736,7 +4736,7 @@ default AuditableRestAction removeRoleFromMember(@Nonnull String userId, @ * Modifies the complete {@link net.dv8tion.jda.api.entities.Role Role} set of the specified {@link net.dv8tion.jda.api.entities.Member Member} *
                                                            The provided roles will replace all current Roles of the specified Member. * - *

                                                            Warning

                                                            + *

                                                            Warning

                                                            * This may not be used together with any other role add/remove/modify methods for the same Member * within one event listener cycle! The changes made by this require cache updates which are triggered by * lifecycle events which are received later. This may only be called again once the specific Member has been updated @@ -4754,7 +4754,7 @@ default AuditableRestAction removeRoleFromMember(@Nonnull String userId, @ *
                                                            The target Member was removed from the Guild before finishing the task *
                                                          * - *

                                                          Example

                                                          + *

                                                          Example

                                                          *
                                                          {@code
                                                                * public static void removeRoles(Member member) {
                                                                *     Guild guild = member.getGuild();
                                                          @@ -4798,7 +4798,7 @@ default AuditableRestAction modifyMemberRoles(@Nonnull Member member, @Non
                                                                *
                                                                * 

                                                          The new roles must not contain the Public Role of the Guild * - *

                                                          Warning

                                                          + *

                                                          Warning

                                                          * This may not be used together with any other role add/remove/modify methods for the same Member * within one event listener cycle! The changes made by this require cache updates which are triggered by * lifecycle events which are received later. This may only be called again once the specific Member has been updated @@ -4814,7 +4814,7 @@ default AuditableRestAction modifyMemberRoles(@Nonnull Member member, @Non *
                                                          The target Member was removed from the Guild before finishing the task *
                                                        * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void makeModerator(Member member) {
                                                              *     Guild guild = member.getGuild();
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/entities/GuildMessageChannel.java b/src/main/java/net/dv8tion/jda/api/entities/GuildMessageChannel.java
                                                        index 439aa7d06c..ec1d9a578e 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/entities/GuildMessageChannel.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/entities/GuildMessageChannel.java
                                                        @@ -469,7 +469,7 @@ default RestAction clearReactionsById(long messageId)
                                                             /**
                                                              * Removes all reactions for the specified emoji.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        
                                                              * // custom
                                                              * channel.clearReactions(messageId, "minn:245267426227388416").queue();
                                                        @@ -551,7 +551,7 @@ default RestAction clearReactionsById(@Nonnull String messageId, @Nonnull
                                                             /**
                                                              * Removes all reactions for the specified emoji.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        
                                                              * // custom
                                                              * channel.clearReactions(messageId, "minn:245267426227388416").queue();
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/entities/IMentionable.java b/src/main/java/net/dv8tion/jda/api/entities/IMentionable.java
                                                        index 78a001c41f..be6b049687 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/entities/IMentionable.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/entities/IMentionable.java
                                                        @@ -26,7 +26,7 @@
                                                         /**
                                                          * Marks a mentionable entity.
                                                          *
                                                        - * 

                                                        Formattable

                                                        + *

                                                        Formattable

                                                        * This interface extends {@link java.util.Formattable Formattable} and can be used with a {@link java.util.Formatter Formatter} * such as used by {@link String#format(String, Object...) String.format(String, Object...)} * or {@link java.io.PrintStream#printf(String, Object...) PrintStream.printf(String, Object...)}. diff --git a/src/main/java/net/dv8tion/jda/api/entities/Message.java b/src/main/java/net/dv8tion/jda/api/entities/Message.java index 91b2712e5f..e4cda83086 100644 --- a/src/main/java/net/dv8tion/jda/api/entities/Message.java +++ b/src/main/java/net/dv8tion/jda/api/entities/Message.java @@ -77,7 +77,7 @@ * as per interface specifications. *
                                                        Specific operations may have specified information available in the {@code throws} javadoc. * - *

                                                        Formattable

                                                        + *

                                                        Formattable

                                                        * This interface extends {@link java.util.Formattable Formattable} and can be used with a {@link java.util.Formatter Formatter} * such as used by {@link String#format(String, Object...) String.format(String, Object...)} * or {@link java.io.PrintStream#printf(String, Object...) PrintStream.printf(String, Object...)}. @@ -172,7 +172,7 @@ public interface Message extends ISnowflake, Formattable /** * Pattern used to find {@link #getJumpUrl() Jump URLs} in strings. * - *

                                                        Groups

                                                        + *

                                                        Groups

                                                        * * * @@ -264,7 +264,7 @@ default Message getReferencedMessage() *
                                                        This can be used to retrieve the amount of times a user was mentioned in this message. This only * counts direct mentions of the user and not mentions through roles or the everyone tag. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public void sendCount(Message msg)
                                                              * {
                                                        @@ -310,7 +310,7 @@ default Message getReferencedMessage()
                                                              * A {@link org.apache.commons.collections4.Bag Bag} of mentioned channels.
                                                              * 
                                                        This can be used to retrieve the amount of times a channel was mentioned in this message. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public void sendCount(Message msg)
                                                              * {
                                                        @@ -360,7 +360,7 @@ default Message getReferencedMessage()
                                                              * counts direct mentions of the role and not mentions through the everyone tag.
                                                              * If a role is not {@link net.dv8tion.jda.api.entities.Role#isMentionable() mentionable} it will not be included.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public void sendCount(Message msg)
                                                              * {
                                                        @@ -928,7 +928,7 @@ default List
                                                        Javadoc is stupid, this is not a required tag
                                                        * * @@ -176,7 +176,7 @@ public interface Webhook extends ISnowflake * The execute token for this Webhook. *
                                                        This can be used to modify/delete/execute * this Webhook. - * + * *

                                                        Note: Some Webhooks, such as those retrieved from Audit Logs, do not contain a token * * @return The execute token for this Webhook @@ -239,7 +239,7 @@ public interface Webhook extends ISnowflake * @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException * If the Webhook does not have a token, such as the Webhooks retrieved from Audit Logs and the currently * logged in account does not have {@link net.dv8tion.jda.api.Permission#MANAGE_WEBHOOKS} in this channel. - * + * * @return {@link net.dv8tion.jda.api.requests.restaction.AuditableRestAction AuditableRestAction} *
                                                        The rest action to delete this Webhook. */ diff --git a/src/main/java/net/dv8tion/jda/api/events/UpdateEvent.java b/src/main/java/net/dv8tion/jda/api/events/UpdateEvent.java index a29679a45d..0fdb8ebe30 100644 --- a/src/main/java/net/dv8tion/jda/api/events/UpdateEvent.java +++ b/src/main/java/net/dv8tion/jda/api/events/UpdateEvent.java @@ -44,7 +44,7 @@ default Class getEntityType() /** * The field name for the updated property * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        
                                                              * {@literal @Override}
                                                              * public void onGenericRoleUpdate(GenericRoleUpdateEvent event)
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/events/thread/ThreadRevealedEvent.java b/src/main/java/net/dv8tion/jda/api/events/thread/ThreadRevealedEvent.java
                                                        index 7175e1a761..efe9af36e1 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/events/thread/ThreadRevealedEvent.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/events/thread/ThreadRevealedEvent.java
                                                        @@ -24,7 +24,7 @@
                                                         /**
                                                          * This event is dispatched when a {@link ThreadChannel} that JDA didn't previously have access to (due to permissions) is now visible.
                                                          *
                                                        - * For example, if the bot is given the {@link net.dv8tion.jda.api.Permission.ADMINISTRATOR} permission, any thread channels that the bot could not previously see would be "revealed".
                                                        + * For example, if the bot is given the {@link net.dv8tion.jda.api.Permission#ADMINISTRATOR} permission, any thread channels that the bot could not previously see would be "revealed".
                                                          *
                                                          * @see ThreadHiddenEvent
                                                          */
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/exceptions/ErrorHandler.java b/src/main/java/net/dv8tion/jda/api/exceptions/ErrorHandler.java
                                                        index d34e487284..a4ef52c7bb 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/exceptions/ErrorHandler.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/exceptions/ErrorHandler.java
                                                        @@ -82,7 +82,7 @@ public ErrorHandler(@Nonnull Consumer base)
                                                             /**
                                                              * Ignore the specified set of error responses.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * // Creates a message with the provided content and deletes it 30 seconds later
                                                              * public static void selfDestruct(MessageChannel channel, String content) {
                                                        @@ -114,7 +114,7 @@ public ErrorHandler ignore(@Nonnull ErrorResponse ignored, @Nonnull ErrorRespons
                                                             /**
                                                              * Ignore the specified set of error responses.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * // Creates a message with the provided content and deletes it 30 seconds later
                                                              * public static void selfDestruct(User user, String content) {
                                                        @@ -143,7 +143,7 @@ public ErrorHandler ignore(@Nonnull Collection errorResponses)
                                                             /**
                                                              * Ignore exceptions of the specified types.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * // Ignore SocketTimeoutException
                                                              * public static void ban(Guild guild, String userId) {
                                                        @@ -183,7 +183,7 @@ public ErrorHandler ignore(@Nonnull Class clazz, @Nonnull Class... classes
                                                             /**
                                                              * Ignore exceptions on specific conditions.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * // Ignore all exceptions except for ErrorResponseException
                                                              * public static void ban(Guild guild, String userId) {
                                                        @@ -211,7 +211,7 @@ public ErrorHandler ignore(@Nonnull Predicate condition)
                                                              * Handle specific {@link ErrorResponse ErrorResponses}.
                                                              * 
                                                        This will apply the specified handler to use instead of the base consumer if one of the provided ErrorResponses happens. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void sendMessage(TextChannel context, User user, String content) {
                                                              *     user.openPrivateChannel()
                                                        @@ -243,7 +243,7 @@ public ErrorHandler handle(@Nonnull ErrorResponse response, @Nonnull ConsumerThis will apply the specified handler to use instead of the base consumer if one of the provided ErrorResponses happens.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void sendMessage(TextChannel context, User user, String content) {
                                                              *     user.openPrivateChannel()
                                                        @@ -276,7 +276,7 @@ public ErrorHandler handle(@Nonnull Collection errorResponses, @N
                                                              * Handle specific throwable types.
                                                              * 
                                                        This will apply the specified handler if the throwable is of the specified type. The check is done using {@link Class#isInstance(Object)}. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void logErrorResponse(RestAction action) {
                                                              *     action.queue(null, new ErrorHandler()
                                                        @@ -307,7 +307,7 @@ public  ErrorHandler handle(@Nonnull Class clazz, @Nonnull ConsumerThis will apply the specified handler if the throwable is of the specified type. The check is done using {@link Class#isInstance(Object)}.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void logErrorResponse(RestAction action) {
                                                              *     action.queue(null, new ErrorHandler()
                                                        @@ -343,7 +343,7 @@ public  ErrorHandler handle(@Nonnull Class clazz, @Nonnull PredicateThis will apply the specified handler if the throwable is of the specified type. The check is done using {@link Class#isInstance(Object)}.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void logErrorResponse(RestAction action) {
                                                              *     action.queue(null, new ErrorHandler()
                                                        @@ -375,7 +375,7 @@ public ErrorHandler handle(@Nonnull Collection> clazz, @Nullable Predic
                                                             /**
                                                              * Handle specific conditions.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void logErrorResponse(RestAction action) {
                                                              *     action.queue(null, new ErrorHandler()
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/exceptions/ErrorResponseException.java b/src/main/java/net/dv8tion/jda/api/exceptions/ErrorResponseException.java
                                                        index b608cd6d8c..986c9ec134 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/exceptions/ErrorResponseException.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/exceptions/ErrorResponseException.java
                                                        @@ -235,7 +235,7 @@ private static SchemaError parseSchemaError(String location, DataObject obj)
                                                             /**
                                                              * Ignore the specified set of error responses.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * // Creates a message with the provided content and deletes it 30 seconds later
                                                              * public static void selfDestruct(MessageChannel channel, String content) {
                                                        @@ -263,7 +263,7 @@ public static Consumer ignore(@Nonnull Collection set)
                                                             /**
                                                              * Ignore the specified set of error responses.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * // Creates a message with the provided content and deletes it 30 seconds later
                                                              * public static void selfDestruct(MessageChannel channel, String content) {
                                                        @@ -293,7 +293,7 @@ public static Consumer ignore(@Nonnull ErrorResponse ignored, @Nonnul
                                                             /**
                                                              * Ignore the specified set of error responses.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * // Creates a message with the provided content and deletes it 30 seconds later
                                                              * public static void selfDestruct(MessageChannel channel, String content) {
                                                        @@ -325,7 +325,7 @@ public static Consumer ignore(@Nonnull Consumer or
                                                             /**
                                                              * Ignore the specified set of error responses.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * // Creates a message with the provided content and deletes it 30 seconds later
                                                              * public static void selfDestruct(MessageChannel channel, String content) {
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/interactions/components/LayoutComponent.java b/src/main/java/net/dv8tion/jda/api/interactions/components/LayoutComponent.java
                                                        index a035dbad9b..78aa369ad8 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/interactions/components/LayoutComponent.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/interactions/components/LayoutComponent.java
                                                        @@ -252,7 +252,7 @@ else if (!components.isValid() && newComponent != null)
                                                         
                                                             /**
                                                              * Find and replace a component in this layout.
                                                        -     * 
                                                        This will locate and replace the existing component by checking for {@link ItemComponent#equals(Object) equality}. If you provide null it will be removed instead. + *
                                                        This will locate and replace the existing component by checking for {@link Object#equals(Object) equality}. If you provide null it will be removed instead. * *

                                                        Example *

                                                        {@code
                                                        @@ -293,7 +293,7 @@ default ItemComponent updateComponent(@Nonnull ItemComponent component, @Nullabl
                                                         
                                                             /**
                                                              * Find and replace a component in this list of layouts.
                                                        -     * 
                                                        This will locate and replace the existing component by checking for {@link ItemComponent#equals(Object) equality}. If you provide null it will be removed instead. + *
                                                        This will locate and replace the existing component by checking for {@link Object#equals(Object) equality}. If you provide null it will be removed instead. * *

                                                        If one of the layouts is empty after removing the component, it will be removed from the list. * This is an inplace operation and modifies the provided list directly. diff --git a/src/main/java/net/dv8tion/jda/api/requests/RestAction.java b/src/main/java/net/dv8tion/jda/api/requests/RestAction.java index db24ef865d..376a907525 100644 --- a/src/main/java/net/dv8tion/jda/api/requests/RestAction.java +++ b/src/main/java/net/dv8tion/jda/api/requests/RestAction.java @@ -93,7 +93,7 @@ * to provide a success and/or failure callback due to the returned {@link java.util.concurrent.ScheduledFuture ScheduledFuture} * not being able to provide the response values of the {@link #queue()} callbacks. * - *

                                                        Using RestActions

                                                        + *

                                                        Using RestActions

                                                        * The most common way to use a RestAction is not using the returned value. *
                                                        For instance sending messages usually means you will not require to view the message once * it was sent. Thus we can simply use the asynchronous {@link #queue()} operation which will @@ -452,7 +452,7 @@ default RestAction addCheck(@Nonnull BooleanSupplier checks) *

                                                        When a RestAction times out, it will fail with a {@link java.util.concurrent.TimeoutException TimeoutException}. * This is the same as {@code deadline(System.currentTimeMillis() + unit.toMillis(timeout))}. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * action.timeout(10, TimeUnit.SECONDS) // 10 seconds from now
                                                              *       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
                                                        @@ -485,7 +485,7 @@ default RestAction timeout(long timeout, @Nonnull TimeUnit unit)
                                                              * right before executing the request or within intervals in a worker thread. This only means the request will timeout
                                                              * if the deadline has passed.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * action.deadline(System.currentTimeMillis() + 10000) // 10 seconds from now
                                                              *       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
                                                        @@ -515,7 +515,7 @@ default RestAction deadline(long timestamp)
                                                              *
                                                              * 

                                                        This method is asynchronous * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void sendMessage(MessageChannel channel, String content)
                                                              * {
                                                        @@ -547,7 +547,7 @@ default void queue()
                                                              *
                                                              * 

                                                        This method is asynchronous * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void sendPrivateMessage(User user, String content)
                                                              * {
                                                        @@ -578,7 +578,7 @@ default void queue(@Nullable Consumer success)
                                                              *
                                                              * 

                                                        This method is asynchronous * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void sendPrivateMessage(JDA jda, String userId, String content)
                                                              * {
                                                        @@ -666,7 +666,7 @@ default T complete()
                                                              * representing its completion task.
                                                              * 
                                                        Cancelling the returned Future will result in the cancellation of the Request! * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public static void sendPrivateMessage(JDA jda, String userId, String content)
                                                              * {
                                                        @@ -739,7 +739,7 @@ default RestAction> mapToResult()
                                                              * 

                                                        This does not modify this instance but returns a new RestAction which will apply * the map function on successful execution. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public RestAction retrieveMemberNickname(Guild guild, String userId) {
                                                              *     return guild.retrieveMemberById(userId)
                                                        @@ -771,7 +771,7 @@ default  RestAction map(@Nonnull Function map)
                                                              * 

                                                        This does not modify this instance but returns a new RestAction which will apply * the map function on failed execution. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public RestAction sendMessage(User user, String content) {
                                                              *     return user.openPrivateChannel() // RestAction
                                                        @@ -804,7 +804,7 @@ default RestAction onErrorMap(@Nonnull FunctionThis does not modify this instance but returns a new RestAction which will apply
                                                              * the map function on failed execution.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public RestAction sendMessage(User user, String content) {
                                                              *     return user.openPrivateChannel() // RestAction
                                                        @@ -843,7 +843,7 @@ default RestAction onErrorMap(@Nullable Predicate conditio
                                                              * 

                                                        This does not modify this instance but returns a new RestAction which will apply * the map function on failed execution. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public RestAction sendMessage(User user, TextChannel context, String content) {
                                                              *     return user.openPrivateChannel() // RestAction
                                                        @@ -877,7 +877,7 @@ default RestAction onErrorFlatMap(@Nonnull FunctionThis does not modify this instance but returns a new RestAction which will apply
                                                              * the map function on failed execution.
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public RestAction sendMessage(User user, TextChannel context, String content) {
                                                              *     return user.openPrivateChannel() // RestAction
                                                        @@ -919,7 +919,7 @@ default RestAction onErrorFlatMap(@Nullable Predicate cond
                                                              * 
                                                        The returned RestAction must not be null! * To terminate the execution chain on a specific condition you can use {@link #flatMap(Predicate, Function)}. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public RestAction initializeGiveaway(Guild guild, String channelName) {
                                                              *     return guild.createTextChannel(channelName)
                                                        @@ -954,7 +954,7 @@ default  RestAction flatMap(@Nonnull FunctionThe provided RestAction must not be null!
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * private static final int MAX_COUNT = 1000;
                                                              * public void updateCount(MessageChannel channel, String messageId, int count) {
                                                        @@ -1091,7 +1091,7 @@ default RestAction> zip(@Nonnull RestAction first, @Nonnull
                                                              *
                                                              * 

                                                        This does not modify this instance but returns a new RestAction which will delay its result by the provided delay. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public RestAction selfDestruct(MessageChannel channel, String content) {
                                                              *     return channel.sendMessage("The following message will destroy itself in 1 minute!")
                                                        @@ -1123,7 +1123,7 @@ default RestAction delay(@Nonnull Duration duration)
                                                              *
                                                              * 

                                                        This does not modify this instance but returns a new RestAction which will delay its result by the provided delay. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public RestAction selfDestruct(MessageChannel channel, String content) {
                                                              *     return channel.sendMessage("The following message will destroy itself in 1 minute!")
                                                        @@ -1158,7 +1158,7 @@ default RestAction delay(@Nonnull Duration duration, @Nullable ScheduledExecu
                                                              *
                                                              * 

                                                        This does not modify this instance but returns a new RestAction which will delay its result by the provided delay. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public RestAction selfDestruct(MessageChannel channel, String content) {
                                                              *     return channel.sendMessage("The following message will destroy itself in 1 minute!")
                                                        @@ -1192,7 +1192,7 @@ default RestAction delay(long delay, @Nonnull TimeUnit unit)
                                                              *
                                                              * 

                                                        This does not modify this instance but returns a new RestAction which will delay its result by the provided delay. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public RestAction selfDestruct(MessageChannel channel, String content) {
                                                              *     return channel.sendMessage("The following message will destroy itself in 1 minute!")
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/requests/restaction/MessageAction.java b/src/main/java/net/dv8tion/jda/api/requests/restaction/MessageAction.java
                                                        index 5d928c3966..476652ff12 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/requests/restaction/MessageAction.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/requests/restaction/MessageAction.java
                                                        @@ -60,7 +60,7 @@
                                                          * If you decide not to execute this action, you should call {@link #clearFiles()} to free resources.
                                                          * 
                                                        Note that the garbage collector also frees opened file streams when it finalizes the stream object. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        
                                                          * {@literal @Override}
                                                          *  public void onMessageReceived(MessageReceivedEvent event)
                                                        @@ -101,7 +101,7 @@ public interface MessageAction extends RestAction, Appendable, AllowedM
                                                              * 

                                                        If {@code null} is provided to this method, then all Types will be pingable * (unless whitelisting via one of the {@code mention*} methods is used). * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * // Disable EVERYONE and HERE mentions by default (to avoid mass ping)
                                                              * EnumSet deny = EnumSet.of(Message.MentionType.EVERYONE, Message.MentionType.HERE);
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/AuditLogPaginationAction.java b/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/AuditLogPaginationAction.java
                                                        index ba21d77777..d711f455b8 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/AuditLogPaginationAction.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/AuditLogPaginationAction.java
                                                        @@ -36,7 +36,7 @@
                                                          * Minimum - 1
                                                          * 
                                                        Maximum - 100 * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        
                                                          * public class Listener extends ListenerAdapter
                                                          * {
                                                        @@ -75,7 +75,7 @@ public interface AuditLogPaginationAction extends PaginationActionMaximum - 100
                                                          *
                                                        - * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        
                                                          * /**
                                                          *  * Iterates messages in an async stream and stops once the limit has been reached.
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/PaginationAction.java b/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/PaginationAction.java
                                                        index 4d757bd9b8..a7405873a1 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/PaginationAction.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/PaginationAction.java
                                                        @@ -93,7 +93,7 @@ public interface PaginationAction> extends R
                                                              *
                                                              * 

                                                        Fails if cache is enabled and the target id is newer than the current last id {@literal (id > last)}. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public MessagePaginationAction getOlderThan(MessageChannel channel, long time) {
                                                              *     final long timestamp = TimeUtil.getDiscordTimestamp(time);
                                                        @@ -491,7 +491,7 @@ default CompletableFuture> takeUntilAsync(int limit, @Nonnull final Pred
                                                              * 

                                                        This iteration will include already cached entities, in order to exclude cached * entities use {@link #forEachRemainingAsync(Procedure)} * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * //deletes messages until it finds a user that is still in guild
                                                              * public void cleanupMessages(MessagePaginationAction action)
                                                        @@ -532,7 +532,7 @@ default CompletableFuture forEachAsync(@Nonnull final Procedure ac
                                                              * 

                                                        This iteration will include already cached entities, in order to exclude cached * entities use {@link #forEachRemainingAsync(Procedure, Consumer)} * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * //deletes messages until it finds a user that is still in guild
                                                              * public void cleanupMessages(MessagePaginationAction action)
                                                        @@ -572,7 +572,7 @@ default CompletableFuture forEachAsync(@Nonnull final Procedure ac
                                                              * 

                                                        This iteration will exclude already cached entities, in order to include cached * entities use {@link #forEachAsync(Procedure)} * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * //deletes messages until it finds a user that is still in guild
                                                              * public void cleanupMessages(MessagePaginationAction action)
                                                        @@ -613,7 +613,7 @@ default CompletableFuture forEachRemainingAsync(@Nonnull final ProcedureThis iteration will exclude already cached entities, in order to include cached
                                                              * entities use {@link #forEachAsync(Procedure, Consumer)}
                                                              *
                                                        -     * 

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * //deletes messages until it finds a user that is still in guild
                                                              * public void cleanupMessages(MessagePaginationAction action)
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/ReactionPaginationAction.java b/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/ReactionPaginationAction.java
                                                        index ce6562df36..b8d0d11f53 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/ReactionPaginationAction.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/ReactionPaginationAction.java
                                                        @@ -32,7 +32,7 @@
                                                          * Minimum - 1
                                                          * 
                                                        Maximum - 100 * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                          * // Remove reactions for the specified emoji
                                                          * public static void removeReaction(Message message, String emoji) {
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/ThreadChannelPaginationAction.java b/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/ThreadChannelPaginationAction.java
                                                        index 69d21e38b4..47e1949424 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/ThreadChannelPaginationAction.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/requests/restaction/pagination/ThreadChannelPaginationAction.java
                                                        @@ -34,7 +34,7 @@
                                                          * Minimum - 1
                                                          * 
                                                        Maximum - 100 * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                          * // Clean up all private threads older than 2 weeks
                                                          * public static void cleanupPrivateThreads(TextChannel channel) {
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/sharding/DefaultShardManagerBuilder.java b/src/main/java/net/dv8tion/jda/api/sharding/DefaultShardManagerBuilder.java
                                                        index b7eae88413..0fb9aa66f6 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/sharding/DefaultShardManagerBuilder.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/sharding/DefaultShardManagerBuilder.java
                                                        @@ -650,7 +650,7 @@ public DefaultShardManagerBuilder disableCache(@Nonnull CacheFlag flag, @Nonnull
                                                              * 

                                                        It is not recommended to disable {@link GatewayIntent#GUILD_MEMBERS GatewayIntent.GUILD_MEMBERS} when * using {@link MemberCachePolicy#ALL MemberCachePolicy.ALL} as the members cannot be removed from cache by a leave event without this intent. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * public void configureCache(DefaultShardManagerBuilder builder) {
                                                              *     // Cache members who are in a voice channel
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/utils/AllowedMentions.java b/src/main/java/net/dv8tion/jda/api/utils/AllowedMentions.java
                                                        index 74eeb45475..ce738f746b 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/utils/AllowedMentions.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/utils/AllowedMentions.java
                                                        @@ -44,7 +44,7 @@ public interface AllowedMentions
                                                              * 

                                                        If {@code null} is provided to this method, then all Types will be pingable * (unless whitelisting via one of the {@code mention*} methods is used). * - *

                                                        Example

                                                        + *

                                                        Example

                                                        *
                                                        {@code
                                                              * // Disable EVERYONE and HERE mentions by default (to avoid mass ping)
                                                              * EnumSet deny = EnumSet.of(Message.MentionType.EVERYONE, Message.MentionType.HERE);
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/utils/ClosableIterator.java b/src/main/java/net/dv8tion/jda/api/utils/ClosableIterator.java
                                                        index b192bc7d38..87ecd0da4f 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/utils/ClosableIterator.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/utils/ClosableIterator.java
                                                        @@ -25,7 +25,7 @@
                                                          * 

                                                        This closes automatically when {@link #hasNext()} returns {@code false} but * its recommended to only be used within a {@code try-with-resources} block for safety. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        * This can handle any exceptions thrown while iterating and ensures the lock is released correctly. *
                                                        {@code
                                                          * try (ClosableIterator it = cacheView.lockedIterator()) {
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/utils/LockIterator.java b/src/main/java/net/dv8tion/jda/api/utils/LockIterator.java
                                                        index 4aaf78deb5..0670a33a5f 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/utils/LockIterator.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/utils/LockIterator.java
                                                        @@ -34,7 +34,7 @@
                                                          * 

                                                        This closes automatically when {@link #hasNext()} returns {@code false} but * its recommended to only be used within a {@code try-with-resources} block for safety. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        * This can handle any exceptions thrown while iterating and ensures the lock is released correctly. *
                                                        {@code
                                                          * try (ClosableIterator it = cacheView.lockedIterator()) {
                                                        diff --git a/src/main/java/net/dv8tion/jda/api/utils/TimeFormat.java b/src/main/java/net/dv8tion/jda/api/utils/TimeFormat.java
                                                        index 41621268c5..e8827681ed 100644
                                                        --- a/src/main/java/net/dv8tion/jda/api/utils/TimeFormat.java
                                                        +++ b/src/main/java/net/dv8tion/jda/api/utils/TimeFormat.java
                                                        @@ -64,7 +64,7 @@ public enum TimeFormat
                                                             /**
                                                              * {@link Pattern} used for {@link #parse(String)}.
                                                              *
                                                        -     * 

                                                        Groups

                                                        + *

                                                        Groups

                                                        *
                                                        Javadoc is stupid, this is not a required tag
                                                        * * diff --git a/src/main/java/net/dv8tion/jda/api/utils/cache/CacheView.java b/src/main/java/net/dv8tion/jda/api/utils/cache/CacheView.java index a12b5499f6..5e906488e0 100644 --- a/src/main/java/net/dv8tion/jda/api/utils/cache/CacheView.java +++ b/src/main/java/net/dv8tion/jda/api/utils/cache/CacheView.java @@ -119,7 +119,7 @@ default void forEachUnordered(@Nonnull final Consumer action) * *

                                                        The stream will be closed once this method returns and cannot be used anymore. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        * * {@literal CacheView} view = jda.getUserCache();
                                                        * long shortNames = view.applyStream(stream {@literal ->} stream.filter(it {@literal ->} it.getName().length() {@literal <} 4).count());
                                                        @@ -158,7 +158,7 @@ default R applyStream(@Nonnull Function, ? extends R> acti * *

                                                        The stream will be closed once this method returns and cannot be used anymore. * - *

                                                        Example

                                                        + *

                                                        Example

                                                        * * {@literal CacheView} view = guild.getTextChannelCache();
                                                        * view.acceptStream(stream {@literal ->} stream.filter(it {@literal ->} it.isNSFW()).forEach(it {@literal ->} it.sendMessage("lewd").queue())); diff --git a/src/main/java/net/dv8tion/jda/api/utils/data/etf/ExTermDecoder.java b/src/main/java/net/dv8tion/jda/api/utils/data/etf/ExTermDecoder.java index c5f7b40064..2dd0686f72 100644 --- a/src/main/java/net/dv8tion/jda/api/utils/data/etf/ExTermDecoder.java +++ b/src/main/java/net/dv8tion/jda/api/utils/data/etf/ExTermDecoder.java @@ -41,7 +41,7 @@ public class ExTermDecoder /** * Unpacks the provided term into a java object. * - *

                                                        The mapping is as follows:

                                                        + *

                                                        The mapping is as follows:

                                                        *
                                                          *
                                                        • {@code Small Int | Int -> Integer}
                                                        • *
                                                        • {@code Small BigInt -> Long}
                                                        • @@ -71,7 +71,7 @@ public static Object unpack(ByteBuffer buffer) /** * Unpacks the provided term into a java {@link Map}. * - *

                                                          The mapping is as follows:

                                                          + *

                                                          The mapping is as follows:

                                                          *
                                                            *
                                                          • {@code Small Int | Int -> Integer}
                                                          • *
                                                          • {@code Small BigInt -> Long}
                                                          • @@ -102,7 +102,7 @@ public static Map unpackMap(ByteBuffer buffer) /** * Unpacks the provided term into a java {@link List}. * - *

                                                            The mapping is as follows:

                                                            + *

                                                            The mapping is as follows:

                                                            *
                                                              *
                                                            • {@code Small Int | Int -> Integer}
                                                            • *
                                                            • {@code Small BigInt -> Long}
                                                            • diff --git a/src/main/java/net/dv8tion/jda/api/utils/data/etf/ExTermEncoder.java b/src/main/java/net/dv8tion/jda/api/utils/data/etf/ExTermEncoder.java index e8b78b19e0..98aa40a7b0 100644 --- a/src/main/java/net/dv8tion/jda/api/utils/data/etf/ExTermEncoder.java +++ b/src/main/java/net/dv8tion/jda/api/utils/data/etf/ExTermEncoder.java @@ -40,7 +40,7 @@ public class ExTermEncoder /** * Encodes the provided object into an ETF buffer. * - *

                                                              The mapping is as follows:

                                                              + *

                                                              The mapping is as follows:

                                                              *
                                                                *
                                                              • {@code String -> Binary}
                                                              • *
                                                              • {@code Map -> Map}
                                                        Javadoc is stupid, this is not a required tag