Skip to content

Commit cc20300

Browse files
committed
Add missing javadoc comments
1 parent 037061d commit cc20300

File tree

3 files changed

+10
-2
lines changed

3 files changed

+10
-2
lines changed

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/FormInteractionManager.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
import java.util.Optional;
1111
import java.util.TimeZone;
1212
import java.util.function.Function;
13-
1413
import lombok.RequiredArgsConstructor;
1514
import net.discordjug.javabot.annotations.AutoDetectableComponentHandler;
1615
import net.discordjug.javabot.systems.staff_commands.forms.dao.FormsRepository;

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/model/FormAttachmentInfo.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
* form is attached to a message, this records contains the message's and its
66
* channel IDs.
77
*
8+
* @param messageId id of the message the form is attached to.
9+
* @param messageChannelId id of the message's channel
10+
*
811
* @see FormData
912
*/
1013
public record FormAttachmentInfo(long messageId, long messageChannelId) {

src/main/java/net/discordjug/javabot/systems/staff_commands/forms/model/FormData.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
import java.util.List;
88
import java.util.Objects;
99
import java.util.Optional;
10-
1110
import net.discordjug.javabot.systems.staff_commands.forms.FormInteractionManager;
1211
import net.dv8tion.jda.api.components.label.Label;
1312

@@ -49,6 +48,13 @@ public record FormData(long id, List<FormField> fields, String title, long submi
4948
}
5049
}
5150

51+
/**
52+
* Get information about the form's attachment state. If the form is attached to
53+
* a message, this method will return a non-empty optional containin information
54+
* about the message this form is attached to.
55+
*
56+
* @return optional attachment info
57+
*/
5258
public Optional<FormAttachmentInfo> getAttachmentInfo() {
5359
if (messageChannel != null && messageId != null) {
5460
return Optional.of(new FormAttachmentInfo(messageId, messageChannel));

0 commit comments

Comments
 (0)