Improved documentation

This commit is contained in:
Alexander Sazonov 2022-04-30 22:42:33 +02:00
parent 9cb1668ab0
commit 0e37985884

View File

@ -7,12 +7,12 @@ import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*; import static org.junit.jupiter.api.Assertions.*;
/** /**
* Tests the noise handling of the game: will the passengers the ghost(s) walk(ed) by while going to * Tests the noise handling of the game: do the passengers hear the ghost(s) walking by while the
* their victim receive the right amount of noise notifications? Since the noises heard by * latter move(s) to infect their victim? Since the noises heard by passengers are stored in
* passengers are stored in designated noiseAmount arrays, the following tests check if the content * designated noiseAmount arrays, the following tests check if the content of those arrays matches
* of those arrays matches expected values. Different cases are being analyzed: ghost infects victim * expected values. Different cases are being analyzed: ghost infects victim while being left to him
* while being on his right / on his left; two ghosts infect a victim while coming from the same * / right to him; two ghosts infect a victim while coming from the same side / from different
* side / from different sides; four ghosts dispersed all over the train infect a victim. * sides; four ghosts dispersed all over the train infect a victim.
*/ */
class NoiseHandlerTest { class NoiseHandlerTest {