Skip to content

Commit 0a04d90

Browse files
committed
docs: rewrite documentation for RoleApplicationSystemConfig
1 parent 8651807 commit 0a04d90

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

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

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@
88
/**
99
* Represents the configuration for an application form, including roles and application channel
1010
* pattern.
11+
*
12+
* @param submissionsChannelPattern the pattern used to identify the submissions channel where applications are sent
13+
* @param defaultQuestion the default question that will be asked in the role application form
14+
* @param minimumAnswerLength the minimum number of characters required for the applicant's answer
15+
* @param maximumAnswerLength the maximum number of characters allowed for the applicant's answer
16+
* @param applicationSubmitCooldownMinutes the cooldown time in minutes before the user can submit another application
1117
*/
1218
public record RoleApplicationSystemConfig(
1319
@JsonProperty(value = "submissionsChannelPattern",
@@ -20,9 +26,9 @@ public record RoleApplicationSystemConfig(
2026

2127
/**
2228
* Constructs an instance of {@link RoleApplicationSystemConfig} with the provided parameters.
23-
*
24-
* @param submissionsChannelPattern the pattern used to identify the application channel
25-
* @param defaultQuestion the default question for the form
29+
* <p>
30+
* This constructor ensures that {@code submissionsChannelPattern} and {@code defaultQuestion}
31+
* are not null and that the length of the {@code defaultQuestion} does not exceed the maximum allowed length.
2632
*/
2733
public RoleApplicationSystemConfig {
2834
Objects.requireNonNull(submissionsChannelPattern);

0 commit comments

Comments
 (0)