From 43fe277afe0a09c6f1b9c1f09985f3a5001b8720 Mon Sep 17 00:00:00 2001 From: "(Jip) Willem Wijnia" Date: Mon, 3 Jun 2024 17:11:11 +0200 Subject: [PATCH] Improve documentation --- .../java/com/faforever/commons/replay/ReplayContainer.java | 6 +++--- .../com/faforever/commons/replay/body/ReplayBodyToken.java | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/faf-commons-data/src/main/java/com/faforever/commons/replay/ReplayContainer.java b/faf-commons-data/src/main/java/com/faforever/commons/replay/ReplayContainer.java index c411523a..98935648 100644 --- a/faf-commons-data/src/main/java/com/faforever/commons/replay/ReplayContainer.java +++ b/faf-commons-data/src/main/java/com/faforever/commons/replay/ReplayContainer.java @@ -7,9 +7,9 @@ /** * A container of all the information that a replay may hold once parsed. * - * @param metadata - * @param header - * @param registeredEvents + * @param metadata Metadata that is attached to the FAF replay format. + * @param header The header of the replay that represents the scenario. + * @param registeredEvents The events of the replay that represent the input of players. */ public record ReplayContainer(ReplayMetadata metadata, ReplayHeader header, List registeredEvents) { } diff --git a/faf-commons-data/src/main/java/com/faforever/commons/replay/body/ReplayBodyToken.java b/faf-commons-data/src/main/java/com/faforever/commons/replay/body/ReplayBodyToken.java index 72494168..bd9b0d57 100644 --- a/faf-commons-data/src/main/java/com/faforever/commons/replay/body/ReplayBodyToken.java +++ b/faf-commons-data/src/main/java/com/faforever/commons/replay/body/ReplayBodyToken.java @@ -4,8 +4,8 @@ public record ReplayBodyToken(TokenId tokenId, int tokenSize, byte[] tokenConten public enum TokenId { // Order is crucial - CMDST_ADVANCE, - CMDST_SET_COMMAND_SOURCE, + CMDST_ADVANCE, // advances the tick for the next tokens in the stream + CMDST_SET_COMMAND_SOURCE, // sets the command source for the next tokens in the stream CMDST_COMMAND_SOURCE_TERMINATED, CMDST_VERIFY_CHECKSUM, CMDST_REQUEST_PAUSE,