From 1a2fb7f049f2ab2fe8ffa1f2eee7f782afe06666 Mon Sep 17 00:00:00 2001
From: bluefireoly <bluefireolymp@gmail.com>
Date: Tue, 27 Oct 2020 13:38:44 +0100
Subject: [PATCH] Added documentation for PlayerInputResult

---
 src/main/kotlin/net/axay/kspigot/chat/input/PlayerInput.kt | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/main/kotlin/net/axay/kspigot/chat/input/PlayerInput.kt b/src/main/kotlin/net/axay/kspigot/chat/input/PlayerInput.kt
index d8b3a56a..1af07329 100644
--- a/src/main/kotlin/net/axay/kspigot/chat/input/PlayerInput.kt
+++ b/src/main/kotlin/net/axay/kspigot/chat/input/PlayerInput.kt
@@ -1,3 +1,5 @@
+@file:Suppress("MemberVisibilityCanBePrivate")
+
 package net.axay.kspigot.chat.input
 
 import net.axay.kspigot.chat.KColors
@@ -75,6 +77,9 @@ fun Player.awaitBookInputAsList(
     PlayerInputBookPaged(this, callback, timeoutSeconds)
 }
 
+/**
+ * @param input The input the player gave. Null on timeout or invalid input.
+ */
 class PlayerInputResult<T> internal constructor(val input: T?)
 
 internal abstract class PlayerInput<T>(