Skip to content

Commit 9ff597c

Browse files
committed
docs(VoiceReceiverAdapter): improve message
Write an improved, more specific JavaDoc for VoiceReceiverAdapter. Signed-off-by: Chris Sdogkos <work@chris-sdogkos.com>
1 parent a3b302d commit 9ff597c

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

application/src/main/java/org/togetherjava/tjbot/features/VoiceReceiverAdapter.java

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@
99
import java.util.regex.Pattern;
1010

1111
/**
12-
* Default implementation of {@link VoiceReceiver}.
12+
* Adapter implementation of a {@link VoiceReceiver}. A new receiver can then be registered by
13+
* adding it to {@link Features}.
14+
* <p>
15+
* {@link #onVoiceUpdate(GuildVoiceUpdateEvent)} like the other provided methods can be overridden
16+
* if desired. The default implementation is empty, the adapter will not react to such events.
1317
*/
1418
public class VoiceReceiverAdapter implements VoiceReceiver {
1519

0 commit comments

Comments
 (0)