adding doc comments for test

Gregory Pett · Gregory Pett · commit 1114434287d9 · 2022-12-21T15:40:41.000-05:00
diff --git a/src/test/java/org/kohsuke/github/GHCodeScanningAlertInstanceTest.java b/src/test/java/org/kohsuke/github/GHCodeScanningAlertInstanceTest.java
@@ -21,6 +21,12 @@ public class GHCodeScanningAlertInstanceTest extends AbstractGitHubWireMockTest
     private static final String REPO_NAME = "Pixi";
     private GHCodeScanningAlert alert;
 
+    /**
+     * Gets the first dismissed alert from the mock repo
+     *
+     * @throws Exception
+     *             the exception
+     */
     @Before
     public void setUp() throws Exception {
         GHRepository repo = gitHub.getRepository(GITHUB_API_TEST_ORG + "/" + REPO_NAME);
@@ -35,6 +41,12 @@ private GHCodeScanningAlert getAlertFromRepo(GHRepository repo) {
         return dismissedAlerts.get(0);
     }
 
+    /**
+     * Test list alert instances payload
+     *
+     * @throws IOException
+     *             Signals that an I/O exception has occurred.
+     */
     @Test
     public void testListAlertInstances() throws IOException {
         // Arrange
diff --git a/src/test/java/org/kohsuke/github/GHCodeScanningAlertTest.java b/src/test/java/org/kohsuke/github/GHCodeScanningAlertTest.java
@@ -23,11 +23,20 @@ public class GHCodeScanningAlertTest extends AbstractGitHubWireMockTest {
     private static final String REPO_NAME = "Pixi";
     private GHRepository repo;
 
+    /**
+     * Gets the mock repo
+     *
+     * @throws Exception
+     *             the exception
+     */
     @Before
     public void setUp() throws Exception {
         repo = gitHub.getRepository(GITHUB_API_TEST_ORG + "/" + REPO_NAME);
     }
 
+    /**
+     * Test list code scanning alert payload
+     */
     @Test
     public void testListCodeScanningAlerts() {
         // Arrange
@@ -66,6 +75,12 @@ public void testListCodeScanningAlerts() {
         assertThat(openAlert.getState(), is(GHCodeScanningAlertState.OPEN));
     }
 
+    /**
+     * Test get code scanning alert payload
+     *
+     * @throws IOException
+     *             Signals that an I/O exception has occurred.
+     */
     @Test
     public void testGetCodeScanningAlert() throws IOException {
         // Arrange
