Apply javadoc:fix

hub4j · Nov 1, 2019 · 1ee17da · 1ee17da
1 parent f25dbd1
commit 1ee17da
Show file tree

Hide file tree

Showing 171 changed files with 7,745 additions and 320 deletions.
diff --git a/pom.xml b/pom.xml
@@ -76,6 +76,9 @@
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
           <version>3.1.1</version>
+          <configuration>
+            <source>8</source>
+          </configuration>
         </plugin>
       </plugins>
     </pluginManagement>

diff --git a/src/main/java/org/kohsuke/github/AbuseLimitHandler.java b/src/main/java/org/kohsuke/github/AbuseLimitHandler.java
@@ -11,6 +11,7 @@
  * @see GitHubBuilder#withAbuseLimitHandler(AbuseLimitHandler)
  * @see <a href="https://developer.github.com/v3/#abuse-rate-limits">documentation</a>
  * @see RateLimitHandler
+ * @version $Id: $Id
  */
 public abstract class AbuseLimitHandler {
     /**
@@ -27,7 +28,7 @@ public abstract class AbuseLimitHandler {
      *      this exception (or wrap this exception into another exception and throw it).
      * @param uc
      *      Connection that resulted in an error. Useful for accessing other response headers.
-     * @throws IOException
+     * @throws java.io.IOException if any.
      */
     public abstract void onError(IOException e, HttpURLConnection uc) throws IOException;
 

diff --git a/src/main/java/org/kohsuke/github/EnforcementLevel.java b/src/main/java/org/kohsuke/github/EnforcementLevel.java
@@ -6,11 +6,17 @@
  * This was added during preview API period but it has changed since then.
  *
  * @author Kohsuke Kawaguchi
+ * @version $Id: $Id
  */
 @Deprecated
 public enum EnforcementLevel {
     OFF, NON_ADMINS, EVERYONE;
 
+    /**
+     * <p>toString.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
     public String toString() {
         return name().toLowerCase(Locale.ENGLISH);
     }

diff --git a/src/main/java/org/kohsuke/github/GHApp.java b/src/main/java/org/kohsuke/github/GHApp.java
@@ -13,10 +13,9 @@
  * A Github App.
  *
  * @author Paulo Miguel Almeida
- *
  * @see GitHub#getApp()
+ * @version $Id: $Id
  */
-
 public class GHApp extends GHObject {
 
     private GitHub root;
@@ -33,62 +32,137 @@ public class GHApp extends GHObject {
     private String htmlUrl;
 
 
+    /**
+     * <p>Getter for the field <code>owner</code>.</p>
+     *
+     * @return a {@link org.kohsuke.github.GHUser} object.
+     */
     public GHUser getOwner() {
         return owner;
     }
 
+    /**
+     * <p>Setter for the field <code>owner</code>.</p>
+     *
+     * @param owner a {@link org.kohsuke.github.GHUser} object.
+     */
     public void setOwner(GHUser owner) {
         this.owner = owner;
     }
 
+    /**
+     * <p>Getter for the field <code>name</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
     public String getName() {
         return name;
     }
 
+    /**
+     * <p>Setter for the field <code>name</code>.</p>
+     *
+     * @param name a {@link java.lang.String} object.
+     */
     public void setName(String name) {
         this.name = name;
     }
 
+    /**
+     * <p>Getter for the field <code>description</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
     public String getDescription() {
         return description;
     }
 
+    /**
+     * <p>Setter for the field <code>description</code>.</p>
+     *
+     * @param description a {@link java.lang.String} object.
+     */
     public void setDescription(String description) {
         this.description = description;
     }
 
+    /**
+     * <p>Getter for the field <code>externalUrl</code>.</p>
+     *
+     * @return a {@link java.lang.String} object.
+     */
     public String getExternalUrl() {
         return externalUrl;
     }
 
+    /**
+     * <p>Setter for the field <code>externalUrl</code>.</p>
+     *
+     * @param externalUrl a {@link java.lang.String} object.
+     */
     public void setExternalUrl(String externalUrl) {
         this.externalUrl = externalUrl;
     }
 
+    /**
+     * <p>Getter for the field <code>events</code>.</p>
+     *
+     * @return a {@link java.util.List} object.
+     */
     public List<GHEvent> getEvents() {
         return events;
     }
 
+    /**
+     * <p>Setter for the field <code>events</code>.</p>
+     *
+     * @param events a {@link java.util.List} object.
+     */
     public void setEvents(List<GHEvent> events) {
         this.events = events;
     }
 
+    /**
+     * <p>Getter for the field <code>installationsCount</code>.</p>
+     *
+     * @return a long.
+     */
     public long getInstallationsCount() {
         return installationsCount;
     }
 
+    /**
+     * <p>Setter for the field <code>installationsCount</code>.</p>
+     *
+     * @param installationsCount a long.
+     */
     public void setInstallationsCount(long installationsCount) {
         this.installationsCount = installationsCount;
     }
 
+    /**
+     * <p>Getter for the field <code>htmlUrl</code>.</p>
+     *
+     * @return a {@link java.net.URL} object.
+     */
     public URL getHtmlUrl() {
         return GitHub.parseURL(htmlUrl);
     }
 
+    /**
+     * <p>Getter for the field <code>permissions</code>.</p>
+     *
+     * @return a {@link java.util.Map} object.
+     */
     public Map<String, String> getPermissions() {
         return permissions;
     }
 
+    /**
+     * <p>Setter for the field <code>permissions</code>.</p>
+     *
+     * @param permissions a {@link java.util.Map} object.
+     */
     public void setPermissions(Map<String, String> permissions) {
         this.permissions = permissions;
     }
@@ -117,11 +191,13 @@ public PagedIterable<GHAppInstallation> listInstallations() {
 
     /**
      * Obtain an installation associated with this app
+     *
      * @param id - Installation Id
      *
      * You must use a JWT to access this endpoint.
-     *
      * @see <a href="https://developer.github.com/v3/apps/#get-an-installation">Get an installation</a>
+     * @return a {@link org.kohsuke.github.GHAppInstallation} object.
+     * @throws java.io.IOException if any.
      */
     @Preview @Deprecated
     public GHAppInstallation getInstallationById(long id) throws IOException {
@@ -130,11 +206,13 @@ public GHAppInstallation getInstallationById(long id) throws IOException {
 
     /**
      * Obtain an organization installation associated with this app
+     *
      * @param name - Organization name
      *
      * You must use a JWT to access this endpoint.
-     *
      * @see <a href="https://developer.github.com/v3/apps/#get-an-organization-installation">Get an organization installation</a>
+     * @return a {@link org.kohsuke.github.GHAppInstallation} object.
+     * @throws java.io.IOException if any.
      */
     @Preview @Deprecated
     public GHAppInstallation getInstallationByOrganization(String name) throws IOException {
@@ -143,12 +221,14 @@ public GHAppInstallation getInstallationByOrganization(String name) throws IOExc
 
     /**
      * Obtain an repository installation associated with this app
+     *
      * @param ownerName - Organization or user name
      * @param repositoryName - Repository name
      *
      * You must use a JWT to access this endpoint.
-     *
      * @see <a href="https://developer.github.com/v3/apps/#get-a-repository-installation">Get a repository installation</a>
+     * @return a {@link org.kohsuke.github.GHAppInstallation} object.
+     * @throws java.io.IOException if any.
      */
     @Preview @Deprecated
     public GHAppInstallation getInstallationByRepository(String ownerName, String repositoryName) throws IOException {
@@ -157,11 +237,13 @@ public GHAppInstallation getInstallationByRepository(String ownerName, String re
 
     /**
      * Obtain a user installation associated with this app
+     *
      * @param name - user name
      *
      * You must use a JWT to access this endpoint.
-     *
      * @see <a href="https://developer.github.com/v3/apps/#get-a-user-installation">Get a user installation</a>
+     * @return a {@link org.kohsuke.github.GHAppInstallation} object.
+     * @throws java.io.IOException if any.
      */
     @Preview @Deprecated
     public GHAppInstallation getInstallationByUser(String name) throws IOException {

diff --git a/src/main/java/org/kohsuke/github/GHAppCreateTokenBuilder.java b/src/main/java/org/kohsuke/github/GHAppCreateTokenBuilder.java
@@ -10,8 +10,8 @@
  * Creates a access token for a GitHub App Installation
  *
  * @author Paulo Miguel Almeida
- *
  * @see GHAppInstallation#createToken(Map)
+ * @version $Id: $Id
  */
 public class GHAppCreateTokenBuilder {
     private final GitHub root;
@@ -32,7 +32,7 @@ public class GHAppCreateTokenBuilder {
      * repository_ids, the response does not contain neither the repositories nor the permissions key.
      *
      * @param repositoryIds - Array containing the repositories Ids
-     *
+     * @return a {@link org.kohsuke.github.GHAppCreateTokenBuilder} object.
      */
     @Preview @Deprecated
     public GHAppCreateTokenBuilder repositoryIds(List<Long> repositoryIds) {
@@ -44,6 +44,9 @@ public GHAppCreateTokenBuilder repositoryIds(List<Long> repositoryIds) {
      * Creates an app token with all the parameters.
      *
      * You must use a JWT to access this endpoint.
+     *
+     * @return a {@link org.kohsuke.github.GHAppInstallationToken} object.
+     * @throws java.io.IOException if any.
      */
     @Preview @Deprecated
     public GHAppInstallationToken create() throws IOException {