docs(network): unify request KDocs

Author: xeruf

sdk/src/server-api/sc/protocol/requests/AuthenticateRequest.kt

@@ -3,7 +3,8 @@ package sc.protocol.requests
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 
-/** Sent by Client to authenticate as administrator. Is not answered if successful. */
+/** Authenticates a client as administrator to send [AdminLobbyRequest]s.
+ * Is not answered if successful. */
 @XStreamAlias("authenticate")
 data class AuthenticateRequest(
         @XStreamAsAttribute

sdk/src/server-api/sc/protocol/requests/CancelRequest.kt

@@ -3,7 +3,7 @@ package sc.protocol.requests
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 
-/** Used to cancel game and delete a GameRoom. */
+/** Deletes the GameRoom and cancels the Game within. */
 @XStreamAlias("cancel")
 data class CancelRequest(
         @XStreamAsAttribute

sdk/src/server-api/sc/protocol/requests/ILobbyRequest.kt

@@ -5,5 +5,5 @@ import sc.protocol.ProtocolPacket
 /** Parent for all packets handled by the Lobby.  */
 interface ILobbyRequest: ProtocolPacket
 
-/** Marks requests only allowed as an administrative client. */
+/** Marks requests only allowed after successful authentication. */
 interface AdminLobbyRequest: ILobbyRequest

sdk/src/server-api/sc/protocol/requests/JoinPreparedRoomRequest.kt

@@ -4,8 +4,9 @@ import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 
 /**
- * Used by client to join a room by reservation code.
- * The code can be received from the administrative client who requested game creation via PrepareGameRequest.
+ * Join a prepared game by reservation.
+ * The code is handed out by the administrative client
+ * that created the game via a PrepareGameRequest.
  */
 @XStreamAlias("joinPrepared")
 data class JoinPreparedRoomRequest(

sdk/src/server-api/sc/protocol/requests/ObservationRequest.kt

@@ -3,7 +3,7 @@ package sc.protocol.requests
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 
-/** Request of administrative client to observe a gameRoom specified by given roomId. */
+/** Request by administrative client to observe a gameRoom specified by given roomId. */
 @XStreamAlias("observe")
 data class ObservationRequest(
         @XStreamAsAttribute

sdk/src/server-api/sc/protocol/requests/PlayerScoreRequest.kt

@@ -4,7 +4,7 @@ import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 
 /**
- * Request of administrative client to get score for a player (displayName of player).
+ * Request by administrative client to get score for a player (displayName of player).
  * Only useful if testMode was enabled before game ended.
  */
 @XStreamAlias("scoreForPlayer")

sdk/src/server-api/sc/protocol/requests/PrepareGameRequest.kt

@@ -5,7 +5,7 @@ import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 import com.thoughtworks.xstream.annotations.XStreamImplicit
 import sc.shared.SlotDescriptor
 
-/** Request to prepare a game of [gameType] with slots according to [slotDescriptors]. */
+/** Prepare a game of [gameType] with slots according to [slotDescriptors]. */
 @XStreamAlias("prepare")
 data class PrepareGameRequest(
     @XStreamAsAttribute

sdk/src/server-api/sc/protocol/requests/StepRequest.kt

@@ -3,7 +3,8 @@ package sc.protocol.requests
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 
-/** Sent by administrative client to send a MoveRequest to the current player. Only works for paused games. */
+/** Request by administrative client to send a MoveRequest to the current player.
+ * Only works for paused games. */
 @XStreamAlias("step")
 data class StepRequest @JvmOverloads constructor(
         @XStreamAsAttribute

sdk/src/server-api/sc/protocol/requests/TestModeRequest.kt

@@ -3,7 +3,7 @@ package sc.protocol.requests
 import com.thoughtworks.xstream.annotations.XStreamAlias
 import com.thoughtworks.xstream.annotations.XStreamAsAttribute
 
-/** Send by administrative client to enable or disable testMode. */
+/** Request by administrative client to toggle testMode. */
 @XStreamAlias("testMode")
 class TestModeRequest(
         @XStreamAsAttribute