docs: add more JavaDocs

Author: christolis

application/src/main/java/org/togetherjava/tjbot/features/basic/ChatGPTFormatter.java

@@ -4,13 +4,27 @@
 
 import java.util.Optional;
 
+/**
+ * A utility class for formatting code using ChatGPT.
+ */
 public final class ChatGPTFormatter {
     private final ChatGptService chatGptService;
 
+    /**
+     * Constructs a new {@link ChatGPTFormatter} with the provided {@link ChatGptService}.
+     *
+     * @param chatGptService the {@link ChatGptService} used for formatting code
+     */
     public ChatGPTFormatter(ChatGptService chatGptService) {
         this.chatGptService = chatGptService;
     }
 
+    /**
+     * Formats the provided code using ChatGPT.
+     *
+     * @param code the code to be formatted
+     * @return an Optional containing the formatted code if successful, empty otherwise
+     */
     public Optional<String> format(CharSequence code) {
         return chatGptService.formatCode(code);
     }

application/src/main/java/org/togetherjava/tjbot/features/code/FormatCodeCommand.java

@@ -40,6 +40,12 @@ public MessageEmbed apply(CodeFence codeFence) {
             .build();
     }
 
+    /**
+     * Formats the provided code using either the ChatGPT formatter or the generic formatter.
+     *
+     * @param code the code to be formatted
+     * @return the formatted code
+     */
     private String formatCode(CharSequence code) {
         return chatGPTFormatter.format(code).orElse(formatter.format(code));
     }