Fix Javadoc (#494)

darxriggs · web-flow · commit 555f7ba758aa · 2021-10-27T14:08:24.000-07:00
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketBuildStatusNotificationsTrait.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/BitbucketBuildStatusNotificationsTrait.java
@@ -51,7 +51,7 @@ public class BitbucketBuildStatusNotificationsTrait extends SCMSourceTrait {
      */
     @DataBoundConstructor
     public BitbucketBuildStatusNotificationsTrait() {
-        /**
+        /*
          * empty constructor
          */
     }
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/avatars/AvatarCache.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/avatars/AvatarCache.java
@@ -505,7 +505,7 @@ private CacheEntry(AvatarCacheSource source, BufferedImage image, long lastModif
         /**
          * Check if this entry is fetch-able
          *
-         * @return
+         * @return whether the entry can be fetched
          */
         public boolean canFetch() {
             return (source != null && source.canFetch());
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/client/BitbucketCloudApiClient.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/client/BitbucketCloudApiClient.java
@@ -311,7 +311,7 @@ public List<BitbucketPullRequestValue> getPullRequests() throws InterruptedExcep
      * PRs with missing source / destination branch are invalid and should be ignored.
      *
      * @param pr a {@link BitbucketPullRequest}
-     * @return
+     * @return whether the PR should be ignored
      */
     private boolean shouldIgnore(BitbucketPullRequest pr) {
         return pr.getSource().getRepository() == null
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/endpoints/BitbucketEndpointConfiguration.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/endpoints/BitbucketEndpointConfiguration.java
@@ -270,7 +270,7 @@ public synchronized AbstractBitbucketEndpoint findEndpoint(@CheckForNull String
      * Checks to see if the supplied server URL is defined in the global configuration.
      *
      * @param serverUrl the server url to check.
-     * @param clazz
+     * @param clazz the class to check.
      * @return the global configuration for the specified server url or {@code null} if not defined.
      */
     public synchronized Optional<AbstractBitbucketEndpoint> findEndpoint(@CheckForNull String serverUrl,
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/NativeServerHeadEvent.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/NativeServerHeadEvent.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2018, Yieldlab AG
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/NativeServerPullRequestHookProcessor.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/NativeServerPullRequestHookProcessor.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2018, Yieldlab AG
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/NativeServerPushHookProcessor.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/NativeServerPushHookProcessor.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2018, Yieldlab AG
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/PingHookProcessor.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/PingHookProcessor.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2018, Yieldlab AG
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/BitbucketServerVersion.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/BitbucketServerVersion.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2020, CloudBees Inc.
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/BitbucketServerWebhookImplementation.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/BitbucketServerWebhookImplementation.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2018, Yieldlab AG
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/BitbucketServerAPIClient.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/BitbucketServerAPIClient.java
@@ -372,7 +372,7 @@ private void setupPullRequest(BitbucketServerPullRequest pullRequest, BitbucketS
      * PRs with missing source / destination branch are invalid and should be ignored.
      *
      * @param pullRequest a {@link BitbucketPullRequest}
-     * @return
+     * @return whether the PR should be ignored
      */
     private boolean shouldIgnore(BitbucketPullRequest pullRequest) {
         return pullRequest.getSource().getRepository() == null
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/PagedApiResponse.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/PagedApiResponse.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2018, Yieldlab AG
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/repository/NativeBitbucketServerWebhook.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/repository/NativeBitbucketServerWebhook.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2018, Yieldlab AG
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/repository/NativeBitbucketServerWebhooks.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/repository/NativeBitbucketServerWebhooks.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2018, Yieldlab AG
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/events/NativeServerPullRequestEvent.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/events/NativeServerPullRequestEvent.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2018, Yieldlab AG
diff --git a/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/events/NativeServerRefsChangedEvent.java b/src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/events/NativeServerRefsChangedEvent.java
@@ -1,4 +1,4 @@
-/**
+/*
  * The MIT License
  *
  * Copyright (c) 2016-2018, Yieldlab AG
diff --git a/src/test/java/com/cloudbees/jenkins/plugins/bitbucket/WebhookConfigurationTraitTest.java b/src/test/java/com/cloudbees/jenkins/plugins/bitbucket/WebhookConfigurationTraitTest.java
@@ -11,10 +11,6 @@ public class WebhookConfigurationTraitTest {
     @ClassRule
     public static JenkinsRule j = new JenkinsRule();
 
-    /**
-     * Test the default empty value
-     * @throws Exception
-     */
     @Test
     public void ignoredCommittersDefault()
             throws Exception {
@@ -25,10 +21,6 @@ public void ignoredCommittersDefault()
         assertEquals(ctx.webhookConfiguration().getCommittersToIgnore(), "");
     }
 
-    /**
-     * Test a set value
-     * @throws Exception
-     */
     @Test
     public void ignoredCommittersWithValue()
             throws Exception {

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public class BitbucketBuildStatusNotificationsTrait extends SCMSourceTrait {`
`51`	`51`	`*/`
`52`	`52`	`@DataBoundConstructor`
`53`	`53`	`public BitbucketBuildStatusNotificationsTrait() {`
`54`		`- /**`
	`54`	`+ /*`
`55`	`55`	`* empty constructor`
`56`	`56`	`*/`
`57`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -505,7 +505,7 @@ private CacheEntry(AvatarCacheSource source, BufferedImage image, long lastModif`
`505`	`505`	`/**`
`506`	`506`	`* Check if this entry is fetch-able`
`507`	`507`	`*`
`508`		`- * @return`
	`508`	`+ * @return whether the entry can be fetched`
`509`	`509`	`*/`
`510`	`510`	`public boolean canFetch() {`
`511`	`511`	`return (source != null && source.canFetch());`
Original file line number	Diff line number	Diff line change
`@@ -311,7 +311,7 @@ public List<BitbucketPullRequestValue> getPullRequests() throws InterruptedExcep`
`311`	`311`	`* PRs with missing source / destination branch are invalid and should be ignored.`
`312`	`312`	`*`
`313`	`313`	`* @param pr a {@link BitbucketPullRequest}`
`314`		`- * @return`
	`314`	`+ * @return whether the PR should be ignored`
`315`	`315`	`*/`
`316`	`316`	`private boolean shouldIgnore(BitbucketPullRequest pr) {`
`317`	`317`	`return pr.getSource().getRepository() == null`
Original file line number	Diff line number	Diff line change
`@@ -270,7 +270,7 @@ public synchronized AbstractBitbucketEndpoint findEndpoint(@CheckForNull String`
`270`	`270`	`* Checks to see if the supplied server URL is defined in the global configuration.`
`271`	`271`	`*`
`272`	`272`	`* @param serverUrl the server url to check.`
`273`		`- * @param clazz`
	`273`	`+ * @param clazz the class to check.`
`274`	`274`	`* @return the global configuration for the specified server url or {@code null} if not defined.`
`275`	`275`	`*/`
`276`	`276`	`public synchronized Optional<AbstractBitbucketEndpoint> findEndpoint(@CheckForNull String serverUrl,`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-/**`
	`1`	`+/*`
`2`	`2`	`* The MIT License`
`3`	`3`	`*`
`4`	`4`	`* Copyright (c) 2016-2018, Yieldlab AG`