Merge branch 'chore/29-javadoc-server-errors' into 'main'

Reflect criticial changes to JavaDoc docstrings for server

Closes #29

See merge request cs108-fs26/Gruppe-13!60
This commit was merged in pull request #216.
This commit is contained in:
Lars Simon Winzer
2026-03-31 12:29:21 +02:00
4 changed files with 3 additions and 5 deletions
@@ -17,7 +17,7 @@ public class ProtocolParser {
/** /**
* Parses the payload of the provided RawPacket * Parses the payload of the provided RawPacket
* *
* @param packet the RawPacket containing the recieved data * @param payload the payload to parse and check for syntax
* @return created PrimitiveRequest * @return created PrimitiveRequest
*/ */
public static RawRequest parse(String payload) { public static RawRequest parse(String payload) {
@@ -5,7 +5,6 @@ import ch.unibas.dmi.dbis.cs108.casono.server.network.command.parsing.CommandPar
import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus; import ch.unibas.dmi.dbis.cs108.casono.server.network.events.EventBus;
import ch.unibas.dmi.dbis.cs108.casono.server.network.protocol.response.PrimitiveResponse; import ch.unibas.dmi.dbis.cs108.casono.server.network.protocol.response.PrimitiveResponse;
import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.TransportLayer; import ch.unibas.dmi.dbis.cs108.casono.server.network.transport.TransportLayer;
import java.io.IOException;
import java.time.Instant; import java.time.Instant;
import java.util.concurrent.ArrayBlockingQueue; import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.BlockingQueue; import java.util.concurrent.BlockingQueue;
@@ -25,7 +24,6 @@ public class Session {
* *
* @param transport the transport layer for communication * @param transport the transport layer for communication
* @param eventBus the event bus for publishing events * @param eventBus the event bus for publishing events
* @throws IOException if an I/O error occurs during initialization
*/ */
public Session( public Session(
TransportLayer transport, TransportLayer transport,
@@ -14,7 +14,7 @@ public class SessionId {
/** /**
* Creates a new SessionId with the specified UUID. * Creates a new SessionId with the specified UUID.
* *
* @param UUID to use for this SessionId * @param value UUID to use for this SessionId
*/ */
public SessionId(UUID value) { public SessionId(UUID value) {
this.value = value; this.value = value;
@@ -88,7 +88,7 @@ public class SessionManager {
/** /**
* Handler for the DisconnectEvent * Handler for the DisconnectEvent
* *
* @param id of the session that disconnected * @param event the DisconnectEvent to handle
*/ */
public void onDisconnect(DisconnectEvent event) { public void onDisconnect(DisconnectEvent event) {
logger.debug("Recieved DisconnectEvent event for session {}", event.sessionId().value()); logger.debug("Recieved DisconnectEvent event for session {}", event.sessionId().value());