Bug: Javadoc fails with 4 @param/@throws errors during build-cs108 #29

New Issue

2026-03-30T23:48:20+02:00

jona.walpert commented

2026-03-30 23:48:20 +02:00

(Migrated from git.scicore.unibas.ch)

Running .gradlew.bat build-cs108 fails because the javadoc task errors out (4 errors), blocking creation of the executable JAR and the Javadoc JAR.

Steps to reproduce:

Open repo root.
Run: gradlew build-cs108

Expected behavior:

javadoc completes (at most warnings) and build-cs108 produces the executable JAR and the Javadoc JAR.

Actual behavior:

javadoc fails with 4 errors (plus many warnings) and the build aborts.

Errors (from javadoc output):

ProtocolParser — mismatched @param name
File: ProtocolParser.java

Problem: Javadoc documents @param packet but method parameter is payload.

Session — @throws declared but exception not thrown
File: Session.java

Problem: @throws IOException declared in Javadoc but constructor does not throw it.

SessionId — @param uses type name instead of parameter name
File: SessionId.java

Problem: @param tag uses UUID as the name instead of the parameter name value.

SessionManager.onDisconnect — @param name mismatch
File: SessionManager.java

Problem: Javadoc documents @param id but method parameter is named event.

Affected files:

ProtocolParser.java
Session.java
SessionId.java
SessionManager.java

Running `.gradlew.bat build-cs108` fails because the `javadoc` task errors out (4 errors), blocking creation of the executable JAR and the Javadoc JAR. Steps to reproduce: 1. Open repo root. 2. Run: `gradlew build-cs108` Expected behavior: * `javadoc` completes (at most warnings) and `build-cs108` produces the executable JAR and the Javadoc JAR. Actual behavior: * `javadoc` fails with 4 errors (plus many warnings) and the build aborts. Errors (from javadoc output): 1. ProtocolParser — mismatched `@param` name\ File: ProtocolParser.java Problem: Javadoc documents `@param packet` but method parameter is payload. 2. Session — `@throws` declared but exception not thrown\ File: Session.java Problem: @throws IOException declared in Javadoc but constructor does not throw it. 3. SessionId — `@param` uses type name instead of parameter name\ File: SessionId.java Problem: `@param` tag uses UUID as the name instead of the parameter name value. 4. SessionManager.onDisconnect — `@param` name mismatch\ File: SessionManager.java Problem: Javadoc documents @param id but method parameter is named event. Affected files: * ProtocolParser.java * Session.java * SessionId.java * SessionManager.java

lars.winzer commented

2026-03-31 12:18:27 +02:00

(Migrated from git.scicore.unibas.ch)

assigned to @lars.winzer

lars.winzer commented

2026-03-31 12:20:21 +02:00

(Migrated from git.scicore.unibas.ch)

created branch chore/29-javadoc-server-errors to address this issue

created branch [`chore/29-javadoc-server-errors`](/cs108-fs26/Gruppe-13/-/compare/main...chore%2F29-javadoc-server-errors) to address this issue

lars.winzer commented

2026-03-31 12:28:07 +02:00

(Migrated from git.scicore.unibas.ch)