Fix test javadocs

hub4j · Sep 27, 2022 · 2b8dde2 · 2b8dde2
1 parent e2d129e
commit 2b8dde2
Show file tree

Hide file tree

Showing 21 changed files with 955 additions and 33 deletions.
diff --git a/src/main/java/org/kohsuke/github/AbuseLimitHandler.java b/src/main/java/org/kohsuke/github/AbuseLimitHandler.java
@@ -8,6 +8,7 @@
 
 import javax.annotation.Nonnull;
 
+// TODO: Auto-generated Javadoc
 /**
  * Pluggable strategy to determine what to do when the API abuse limit is hit.
  *

diff --git a/src/test/java/org/kohsuke/github/GHAppTest.java b/src/test/java/org/kohsuke/github/GHAppTest.java
@@ -39,7 +39,6 @@ protected GitHubBuilder getGitHubBuilder() {
     /**
      * Gets the git hub app.
      *
-     * @return the git hub app
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -87,7 +86,6 @@ public void listInstallations() throws IOException {
     /**
      * Gets the installation by id.
      *
-     * @return the installation by id
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -100,7 +98,6 @@ public void getInstallationById() throws IOException {
     /**
      * Gets the installation by organization.
      *
-     * @return the installation by organization
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -113,7 +110,6 @@ public void getInstallationByOrganization() throws IOException {
     /**
      * Gets the installation by repository.
      *
-     * @return the installation by repository
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -126,7 +122,6 @@ public void getInstallationByRepository() throws IOException {
     /**
      * Gets the installation by user.
      *
-     * @return the installation by user
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test

diff --git a/src/test/java/org/kohsuke/github/GHIssueTest.java b/src/test/java/org/kohsuke/github/GHIssueTest.java
@@ -294,7 +294,6 @@ public void setAssignee() throws Exception {
     /**
      * Gets the user test.
      *
-     * @return the user test
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test

diff --git a/src/test/java/org/kohsuke/github/GHLicenseTest.java b/src/test/java/org/kohsuke/github/GHLicenseTest.java
@@ -73,7 +73,6 @@ public void listLicensesCheckIndividualLicense() throws IOException {
      * Checks that the request for an individual license using {@link GitHub#getLicense(String)} returns expected values
      * (not all properties are checked).
      *
-     * @return the license
      * @throws IOException             if test fails
      */
     @Test

diff --git a/src/test/java/org/kohsuke/github/GHPullRequestTest.java b/src/test/java/org/kohsuke/github/GHPullRequestTest.java
@@ -730,7 +730,6 @@ public void setAssignee() throws Exception {
     /**
      * Gets the user test.
      *
-     * @return the user test
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test

diff --git a/src/test/java/org/kohsuke/github/GHRepositoryTest.java b/src/test/java/org/kohsuke/github/GHRepositoryTest.java
@@ -149,7 +149,6 @@ public void isDisabledTrue() throws Exception {
     /**
      * Gets the branch URL encoded.
      *
-     * @return the branch URL encoded
      * @throws Exception the exception
      */
     @Test
@@ -224,7 +223,6 @@ public void listStargazers() throws IOException {
     /**
      * Gets the branch non existent but 200 status.
      *
-     * @return the branch non existent but 200 status
      * @throws Exception the exception
      */
     // Issue #607
@@ -406,7 +404,6 @@ public void listContributors() throws IOException {
     /**
      * Gets the permission.
      *
-     * @return the permission
      * @throws Exception the exception
      */
     @Test
@@ -554,7 +551,6 @@ public void listReleases() throws IOException {
     /**
      * Gets the release exists.
      *
-     * @return the release exists
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -566,7 +562,6 @@ public void getReleaseExists() throws IOException {
     /**
      * Gets the release does not exist.
      *
-     * @return the release does not exist
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -578,7 +573,6 @@ public void getReleaseDoesNotExist() throws IOException {
     /**
      * Gets the release by tag name exists.
      *
-     * @return the release by tag name exists
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -591,7 +585,6 @@ public void getReleaseByTagNameExists() throws IOException {
     /**
      * Gets the release by tag name does not exist.
      *
-     * @return the release by tag name does not exist
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -889,7 +882,6 @@ public void setMergeOptions() throws IOException {
     /**
      * Gets the delete branch on merge.
      *
-     * @return the delete branch on merge
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -963,7 +955,6 @@ public void testSetTopics() throws Exception {
     /**
      * Gets the collaborators.
      *
-     * @return the collaborators
      * @throws Exception the exception
      */
     @Test
@@ -976,7 +967,6 @@ public void getCollaborators() throws Exception {
     /**
      * Gets the post commit hooks.
      *
-     * @return the post commit hooks
      * @throws Exception the exception
      */
     @Test
@@ -989,7 +979,6 @@ public void getPostCommitHooks() throws Exception {
     /**
      * Gets the refs.
      *
-     * @return the refs
      * @throws Exception the exception
      */
     @Test
@@ -1004,7 +993,6 @@ public void getRefs() throws Exception {
     /**
      * Gets the public key.
      *
-     * @return the public key
      * @throws Exception the exception
      */
     @Test
@@ -1019,7 +1007,6 @@ public void getPublicKey() throws Exception {
     /**
      * Gets the refs heads.
      *
-     * @return the refs heads
      * @throws Exception the exception
      */
     @Test
@@ -1034,7 +1021,6 @@ public void getRefsHeads() throws Exception {
     /**
      * Gets the refs empty tags.
      *
-     * @return the refs empty tags
      * @throws Exception the exception
      */
     @Test
@@ -1103,7 +1089,6 @@ public void listRefs() throws Exception {
     /**
      * Gets the ref.
      *
-     * @return the ref
      * @throws Exception the exception
      */
     @Test
@@ -1275,7 +1260,6 @@ public void userIsCollaborator() throws Exception {
     /**
      * Gets the check runs.
      *
-     * @return the check runs
      * @throws Exception the exception
      */
     @Test
@@ -1305,7 +1289,6 @@ public void getCheckRuns() throws Exception {
     /**
      * Gets the last commit status.
      *
-     * @return the last commit status
      * @throws Exception the exception
      */
     @Test
@@ -1362,7 +1345,6 @@ public void listCommitsBetweenPaginated() throws Exception {
     /**
      * Gets the commits between over 250.
      *
-     * @return the commits between over 250
      * @throws Exception the exception
      */
     @Test
@@ -1436,7 +1418,6 @@ public void getCommitsBetweenOver250() throws Exception {
     /**
      * Gets the commits between paged.
      *
-     * @return the commits between paged
      * @throws Exception the exception
      */
     @Test

diff --git a/src/test/java/org/kohsuke/github/GHTeamTest.java b/src/test/java/org/kohsuke/github/GHTeamTest.java
@@ -54,7 +54,6 @@ public void testSetDescription() throws IOException {
     /**
      * Gets the members.
      *
-     * @return the members
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test

diff --git a/src/test/java/org/kohsuke/github/GHUserTest.java b/src/test/java/org/kohsuke/github/GHUserTest.java
@@ -69,7 +69,6 @@ private Set<GHUser> count30(PagedIterable<GHUser> l) {
     /**
      * Gets the keys.
      *
-     * @return the keys
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test

diff --git a/src/test/java/org/kohsuke/github/GitHubTest.java b/src/test/java/org/kohsuke/github/GitHubTest.java
@@ -33,7 +33,6 @@ public void listUsers() throws IOException {
     /**
      * Gets the repository.
      *
-     * @return the repository
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -63,7 +62,6 @@ public void getRepository() throws IOException {
     /**
      * Gets the orgs.
      *
-     * @return the orgs
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -265,7 +263,6 @@ public void testListMyAuthorizations() throws IOException {
     /**
      * Gets the meta.
      *
-     * @return the meta
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test
@@ -304,7 +301,6 @@ public void getMeta() throws IOException {
     /**
      * Gets the my marketplace purchases.
      *
-     * @return the my marketplace purchases
      * @throws IOException Signals that an I/O exception has occurred.
      */
     @Test

diff --git a/src/test/java/org/kohsuke/github/extras/GitHubCachingTest.java b/src/test/java/org/kohsuke/github/extras/GitHubCachingTest.java
@@ -22,24 +22,39 @@
 
 import static org.junit.Assert.fail;
 
+// TODO: Auto-generated Javadoc
 /**
  * Test showing the behavior of OkHttpGitHubConnector cache with GitHub 404 responses.
  *
  * @author Liam Newman
  */
 public class GitHubCachingTest extends AbstractGitHubWireMockTest {
 
+    /**
+     * Instantiates a new git hub caching test.
+     */
     public GitHubCachingTest() {
         useDefaultGitHub = false;
     }
 
+    /** The test ref name. */
     String testRefName = "heads/test/content_ref_cache";
 
+    /**
+     * Gets the wire mock options.
+     *
+     * @return the wire mock options
+     */
     @Override
     protected WireMockConfiguration getWireMockOptions() {
         return super.getWireMockOptions().extensions(templating.newResponseTransformer());
     }
 
+    /**
+     * Setup repo.
+     *
+     * @throws Exception the exception
+     */
     @Before
     public void setupRepo() throws Exception {
         if (mockGitHub.isUseProxy()) {
@@ -54,6 +69,11 @@ public void setupRepo() throws Exception {
         }
     }
 
+    /**
+     * Test cached 404.
+     *
+     * @throws Exception the exception
+     */
     @Test
     public void testCached404() throws Exception {
         Assume.assumeFalse(SystemUtils.IS_OS_WINDOWS);