From 4656efc71c7365bce34f73e894518a1a2c09fb9a Mon Sep 17 00:00:00 2001
From: Zabuzard <zabuza.dev@gmail.com>
Date: Tue, 26 Aug 2025 11:26:13 +0200
Subject: [PATCH] Proper doc for FeatureBlacklist

---
 .../tjbot/config/FeatureBlacklistConfig.java   | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/application/src/main/java/org/togetherjava/tjbot/config/FeatureBlacklistConfig.java b/application/src/main/java/org/togetherjava/tjbot/config/FeatureBlacklistConfig.java
index 231cbdb4f8..7268a3b9dc 100644
--- a/application/src/main/java/org/togetherjava/tjbot/config/FeatureBlacklistConfig.java
+++ b/application/src/main/java/org/togetherjava/tjbot/config/FeatureBlacklistConfig.java
@@ -6,7 +6,25 @@
 
 /**
  * Configuration of the feature blacklist, any feature present here will be disabled.
+ * <p>
+ * The argument {@code "normal"} expects a list of fully qualified class names of
+ * {@link org.togetherjava.tjbot.features.Feature}s, for example:
  * 
+ * <pre>
+ * {@code
+ * "normal": [
+ *   "org.togetherjava.tjbot.features.basic.PingCommand",
+ *   "org.togetherjava.tjbot.features.tophelper.TopHelpersAssignmentRoutine"
+ * ]}
+ * </pre>
+ * <p>
+ * The argument {@code "special"} is a special set of predefined strings that disable specific
+ * features. Currently available are:
+ * <ul>
+ * <li>{@code "org.togetherjava.tjbot.features.code.FormatCodeCommand"}</li>
+ * <li>{@code "org.togetherjava.tjbot.features.code.EvalCodeCommand"}</li>
+ * </ul>
+ *
  * @param normal the normal features, which are present in
  *        {@link org.togetherjava.tjbot.features.Features}
  * @param special the special features, which require special code