fix checkstyle - missing javadocs

c-eg · Aug 10, 2024 · 740281d · 740281d
1 parent a9e188c
commit 740281d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/test/java/uk/co/conoregan/watch2getherapi/Watch2GetherApiTest.java b/src/test/java/uk/co/conoregan/watch2getherapi/Watch2GetherApiTest.java
@@ -17,8 +17,14 @@
 import static com.github.tomakehurst.wiremock.client.WireMock.stubFor;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 
+/**
+ * Tests for {@link Watch2GetherApi}.
+ */
 @WireMockTest
 public class Watch2GetherApiTest {
+    /**
+     * Tests {@link Watch2GetherApi#createRoom(String, String, Integer)} with an expected result.
+     */
     @Test
     public void testCreateRoom(WireMockRuntimeInfo wmRuntimeInfo) throws W2GException, IOException {
         String responseBody = TestUtils.readTestFile("api_responses/create_room.json");
@@ -29,6 +35,9 @@ public void testCreateRoom(WireMockRuntimeInfo wmRuntimeInfo) throws W2GExceptio
         assertNotNull(createRoomResponse);
     }
 
+    /**
+     * Tests {@link Watch2GetherApi#shareItem(String, String)} with an expected result.
+     */
     @Test
     public void testShareItem(WireMockRuntimeInfo wmRuntimeInfo) throws W2GException {
         String streamKey = "streamKey";
@@ -38,6 +47,9 @@ public void testShareItem(WireMockRuntimeInfo wmRuntimeInfo) throws W2GException
         api.shareItem(streamKey, "https://www.youtube.com/watch?v=dQw4w9WgXcQ");
     }
 
+    /**
+     * Tests {@link Watch2GetherApi#addToPlaylist(String, List)} with an expected result.
+     */
     @Test
     public void testAddToPlaylist(WireMockRuntimeInfo wmRuntimeInfo) throws W2GException {
         String streamKey = "streamKey";