Add tags to doc generation

Kaktushose · Dec 25, 2024 · 90ab55e · 90ab55e
1 parent e952ef2
commit 90ab55e
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/pom.xml b/pom.xml
@@ -43,6 +43,24 @@
                         <link>https://javadoc.io/doc/net.dv8tion/JDA/5.0.2</link>
                     </links>
                     <docfilessubdirs>true</docfilessubdirs>
+
+                    <tags>
+                        <tag>
+                            <name>apiNote</name>
+                            <placement>a</placement>
+                            <head>API Note</head>
+                        </tag>
+                        <tag>
+                            <name>implSpec</name>
+                            <placement>a</placement>
+                            <head>Implementation Requirements</head>
+                        </tag>
+                        <tag>
+                            <name>implNote</name>
+                            <placement>a</placement>
+                            <head>Implementation Note</head>
+                        </tag>
+                    </tags>
                 </configuration>
             </plugin>
             <plugin>

diff --git a/src/main/java/com/github/kaktushose/jda/commands/dispatching/InvocationContext.java b/src/main/java/com/github/kaktushose/jda/commands/dispatching/InvocationContext.java
@@ -23,8 +23,8 @@ public record InvocationContext<T extends GenericInteractionCreateEvent>(
 ) {
     /// Stops further execution of this invocation at the next suitable moment.
     ///
-    /// @implNote This will interrupt the current event thread
     /// @param errorMessage the error message that should be sent to the user as a reply
+    /// @implNote This will interrupt the current event thread
     public void cancel(MessageCreateData errorMessage) {
         new MessageReply(event, definition, new ReplyConfig()).reply(errorMessage);