Skip to content

Commit 6f64695

Browse files
authored
Proper doc for FeatureBlacklist (#1309)
1 parent a2771b1 commit 6f64695

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

application/src/main/java/org/togetherjava/tjbot/config/FeatureBlacklistConfig.java

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,25 @@
66

77
/**
88
* Configuration of the feature blacklist, any feature present here will be disabled.
9+
* <p>
10+
* The argument {@code "normal"} expects a list of fully qualified class names of
11+
* {@link org.togetherjava.tjbot.features.Feature}s, for example:
912
*
13+
* <pre>
14+
* {@code
15+
* "normal": [
16+
* "org.togetherjava.tjbot.features.basic.PingCommand",
17+
* "org.togetherjava.tjbot.features.tophelper.TopHelpersAssignmentRoutine"
18+
* ]}
19+
* </pre>
20+
* <p>
21+
* The argument {@code "special"} is a special set of predefined strings that disable specific
22+
* features. Currently available are:
23+
* <ul>
24+
* <li>{@code "org.togetherjava.tjbot.features.code.FormatCodeCommand"}</li>
25+
* <li>{@code "org.togetherjava.tjbot.features.code.EvalCodeCommand"}</li>
26+
* </ul>
27+
*
1028
* @param normal the normal features, which are present in
1129
* {@link org.togetherjava.tjbot.features.Features}
1230
* @param special the special features, which require special code

0 commit comments

Comments
 (0)