Skip to content

Proper doc for FeatureBlacklist #1309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 26, 2025
Merged

Proper doc for FeatureBlacklist #1309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions application/src/main/java/org/togetherjava/tjbot/config/FeatureBlacklistConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down