Improve documentation

FAForever · Jun 3, 2024 · 43fe277 · 43fe277
1 parent 82d50df
commit 43fe277
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 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
@@ -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<RegisteredEvent> 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
@@ -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,