Fixed several javadoc issues.

Author: khmarbaise

jenkins-client/src/main/java/com/offbytwo/jenkins/JenkinsServer.java

@@ -52,7 +52,7 @@
 import net.sf.json.JSONObject;
 
 public class JenkinsHttpClient {
-    private final Logger LOGGER = LoggerFactory.getLogger( getClass() );
+    private final Logger LOGGER = LoggerFactory.getLogger(getClass());
 
     private URI uri;
     private CloseableHttpClient client;
@@ -62,16 +62,14 @@ public class JenkinsHttpClient {
 
     private ObjectMapper mapper;
     private String context;
-    
+
     private String jenkinsVersion;
 
     /**
      * Create an unauthenticated Jenkins HTTP client
      *
-     * @param uri
-     *            Location of the jenkins server (ex. http://localhost:8080)
-     * @param client
-     *            Configured CloseableHttpClient to be used
+     * @param uri Location of the jenkins server (ex. http://localhost:8080)
+     * @param client Configured CloseableHttpClient to be used
      */
     public JenkinsHttpClient(URI uri, CloseableHttpClient client) {
         this.context = uri.getPath();
@@ -90,10 +88,8 @@ public JenkinsHttpClient(URI uri, CloseableHttpClient client) {
     /**
      * Create an unauthenticated Jenkins HTTP client
      *
-     * @param uri
-     *            Location of the jenkins server (ex. http://localhost:8080)
-     * @param builder
-     *            Configured HttpClientBuilder to be used
+     * @param uri Location of the jenkins server (ex. http://localhost:8080)
+     * @param builder Configured HttpClientBuilder to be used
      */
     public JenkinsHttpClient(URI uri, HttpClientBuilder builder) {
         this(uri, builder.build());
@@ -102,8 +98,7 @@ public JenkinsHttpClient(URI uri, HttpClientBuilder builder) {
     /**
      * Create an unauthenticated Jenkins HTTP client
      *
-     * @param uri
-     *            Location of the jenkins server (ex. http://localhost:8080)
+     * @param uri Location of the jenkins server (ex. http://localhost:8080)
      */
     public JenkinsHttpClient(URI uri) {
         this(uri, HttpClientBuilder.create());
@@ -112,12 +107,9 @@ public JenkinsHttpClient(URI uri) {
     /**
      * Create an authenticated Jenkins HTTP client
      *
-     * @param uri
-     *            Location of the jenkins server (ex. http://localhost:8080)
-     * @param username
-     *            Username to use when connecting
-     * @param password
-     *            Password or auth token to use when connecting
+     * @param uri Location of the jenkins server (ex. http://localhost:8080)
+     * @param username Username to use when connecting
+     * @param password Password or auth token to use when connecting
      */
     public JenkinsHttpClient(URI uri, String username, String password) {
         this(uri, addAuthentication(HttpClientBuilder.create(), uri, username, password));
@@ -130,19 +122,15 @@ public JenkinsHttpClient(URI uri, String username, String password) {
     /**
      * Perform a GET request and parse the response to the given class
      *
-     * @param path
-     *            path to request, can be relative or absolute
-     * @param cls
-     *            class of the response
-     * @param <T>
-     *            type of the response
+     * @param path path to request, can be relative or absolute
+     * @param cls class of the response
+     * @param <T> type of the response
      * @return an instance of the supplied class
-     * @throws IOException,
-     *             HttpResponseException
+     * @throws IOException in case of an error.
      */
     public <T extends BaseModel> T get(String path, Class<T> cls) throws IOException {
         HttpGet getMethod = new HttpGet(api(path));
-        
+
         HttpResponse response = client.execute(getMethod, localContext);
         getJenkinsVersionFromHeader(response);
         try {
@@ -158,17 +146,16 @@ public <T extends BaseModel> T get(String path, Class<T> cls) throws IOException
      * Perform a GET request and parse the response and return a simple string
      * of the content
      *
-     * @param path
-     *            path to request, can be relative or absolute
+     * @param path path to request, can be relative or absolute
      * @return the entity text
-     * @throws IOException,
-     *             HttpResponseException
+     * @throws IOException in case of an error.
      */
     public String get(String path) throws IOException {
         HttpGet getMethod = new HttpGet(api(path));
         HttpResponse response = client.execute(getMethod, localContext);
         getJenkinsVersionFromHeader(response);
-        LOGGER.debug("get({}), version={}, responseCode={}", path, this.jenkinsVersion, response.getStatusLine().getStatusCode());
+        LOGGER.debug("get({}), version={}, responseCode={}", path, this.jenkinsVersion,
+                response.getStatusLine().getStatusCode());
         try {
             httpResponseValidator.validateResponse(response);
             return IOUtils.toString(response.getEntity().getContent());
@@ -183,12 +170,9 @@ public String get(String path) throws IOException {
      * Perform a GET request and parse the response to the given class, logging
      * any IOException that is thrown rather than propagating it.
      *
-     * @param path
-     *            path to request, can be relative or absolute
-     * @param cls
-     *            class of the response
-     * @param <T>
-     *            type of the response
+     * @param path path to request, can be relative or absolute
+     * @param cls class of the response
+     * @param <T> type of the response
      * @return an instance of the supplied class
      */
     public <T extends BaseModel> T getQuietly(String path, Class<T> cls) {
@@ -198,19 +182,17 @@ public <T extends BaseModel> T getQuietly(String path, Class<T> cls) {
             return value;
         } catch (IOException e) {
             LOGGER.debug("getQuietly({}, {})", path, cls.getName(), e);
-            //TODO: Is returing null a good idea?
+            // TODO: Is returing null a good idea?
             return null;
         }
     }
 
     /**
      * Perform a GET request and return the response as InputStream
      *
-     * @param path
-     *            path to request, can be relative or absolute
+     * @param path path to request, can be relative or absolute
      * @return the response stream
-     * @throws IOException,
-     *             HttpResponseException
+     * @throws IOException in case of an error.
      */
     public InputStream getFile(URI path) throws IOException {
         HttpGet getMethod = new HttpGet(path);
@@ -227,19 +209,14 @@ public <R extends BaseModel, D> R post(String path, D data, Class<R> cls) throws
     /**
      * Perform a POST request and parse the response to the given class
      *
-     * @param path
-     *            path to request, can be relative or absolute
-     * @param data
-     *            data to post
-     * @param cls
-     *            class of the response
-     * @param <R>
-     *            type of the response
-     * @param <D>
-     *            type of the data
+     * @param path path to request, can be relative or absolute
+     * @param data data to post
+     * @param cls class of the response
+     * @param <R> type of the response
+     * @param <D> type of the data
+     * @param crumbFlag true / false.
      * @return an instance of the supplied class
-     * @throws IOException,
-     *             HttpResponseException
+     * @throws IOException in case of an error.
      */
     public <R extends BaseModel, D> R post(String path, D data, Class<R> cls, boolean crumbFlag) throws IOException {
         HttpPost request = new HttpPost(api(path));
@@ -293,12 +270,10 @@ public <R extends BaseModel, D> R post(String path, D data, Class<R> cls, boolea
      * call required. It is unclear if any other jenkins APIs operate in this
      * fashion.
      *
-     * @param path
-     *            path to request, can be relative or absolute
-     * @param data
-     *            data to post
-     * @throws IOException,
-     *             HttpResponseException
+     * @param path path to request, can be relative or absolute
+     * @param data data to post
+     * @param crumbFlag true / false.
+     * @throws IOException in case of an error.
      */
     public void post_form(String path, Map<String, String> data, boolean crumbFlag) throws IOException {
         HttpPost request;
@@ -341,13 +316,10 @@ public void post_form(String path, Map<String, String> data, boolean crumbFlag)
      * Perform a POST request of XML (instead of using json mapper) and return a
      * string rendering of the response entity.
      *
-     * @param path
-     *            path to request, can be relative or absolute
-     * @param xml_data
-     *            data data to post
+     * @param path path to request, can be relative or absolute
+     * @param xml_data data data to post
      * @return A string containing the xml response (if present)
-     * @throws IOException,
-     *             HttpResponseException
+     * @throws IOException in case of an error.
      */
     public String post_xml(String path, String xml_data) throws IOException {
         return post_xml(path, xml_data, true);
@@ -379,11 +351,11 @@ public String post_xml(String path, String xml_data, boolean crumbFlag) throws I
     /**
      * Post a text entity to the given URL using the default content type
      *
-     * @param path
-     * @param textData
-     * @param crumbFlag
+     * @param path The path.
+     * @param textData data.
+     * @param crumbFlag true/false.
      * @return resulting response
-     * @throws IOException
+     * @throws IOException in case of an error.
      */
     public String post_text(String path, String textData, boolean crumbFlag) throws IOException {
         return post_text(path, textData, ContentType.DEFAULT_TEXT, crumbFlag);
@@ -392,11 +364,12 @@ public String post_text(String path, String textData, boolean crumbFlag) throws
     /**
      * Post a text entity to the given URL with the given content type
      *
-     * @param path
-     * @param textData
-     * @param crumbFlag
+     * @param path The path.
+     * @param textData The data.
+     * @param contentType {@link ContentType}
+     * @param crumbFlag true or false.
      * @return resulting response
-     * @throws IOException
+     * @throws IOException in case of an error.
      */
     public String post_text(String path, String textData, ContentType contentType, boolean crumbFlag)
             throws IOException {
@@ -425,10 +398,8 @@ public String post_text(String path, String textData, ContentType contentType, b
     /**
      * Perform POST request that takes no parameters and returns no response
      *
-     * @param path
-     *            path to request
-     * @throws IOException,
-     *             HttpResponseException
+     * @param path path to request
+     * @throws IOException in case of an error.
      */
     public void post(String path) throws IOException {
         post(path, null, null, false);
@@ -458,7 +429,7 @@ private URI api(String path) {
             String[] components = path.split("\\?", 2);
             path = urlJoin(components[0], "api/json") + "?" + components[1];
         }
-        return uri.resolve("/").resolve(path.replace(" ","%20"));
+        return uri.resolve("/").resolve(path.replace(" ", "%20"));
     }
 
     private URI noapi(String path) {
@@ -495,7 +466,7 @@ private void getJenkinsVersionFromHeader(HttpResponse response) {
         Header[] headers = response.getHeaders("X-Jenkins");
         if (headers.length == 1) {
             this.jenkinsVersion = headers[0].getValue();
-        } 
+        }
     }
 
     private void releaseConnection(HttpRequestBase httpRequestBase) {
@@ -517,10 +488,10 @@ protected static HttpClientBuilder addAuthentication(HttpClientBuilder builder,
     }
 
     protected HttpContext getLocalContext() {
-      return localContext;
+        return localContext;
     }
 
     protected void setLocalContext(HttpContext localContext) {
-      this.localContext = localContext;
+        this.localContext = localContext;
     }
 }

jenkins-client/src/main/java/com/offbytwo/jenkins/client/JenkinsHttpClient.java

@@ -30,7 +30,6 @@
 
 /**
  * This code is copied from Maven Core with slight modifications. Generic implementation of version comparison.
- * <p>
  * Features:
  * <ul>
  * <li>mixing of '<code>-</code>' (hyphen) and '<code>.</code>' (dot) separators,</li>
@@ -52,7 +51,6 @@
  * Unknown qualifiers are considered after known qualifiers, with lexical order (always case insensitive),</li>
  * <li>a hyphen usually precedes a qualifier, and is always less important than something preceded with a dot.</li>
  * </ul>
- * </p>
  *
  * @see <a href="https://cwiki.apache.org/confluence/display/MAVENOLD/Versioning">"Versioning" on Maven Wiki</a>
  * @author <a href="mailto:[email protected]">Kenney Westerhof</a>

jenkins-client/src/main/java/com/offbytwo/jenkins/helper/ComparableVersion.java

@@ -22,14 +22,14 @@ public class BuildChangeSet {
     private String kind;
 
     /**
-    *
-    */
+     * @param items {@link BuildChangeSet}
+     */
     public void setItems(List<BuildChangeSetItem> items) {
         this.items = items;
     }
 
     /**
-     * @return the items
+     * @return list of {@link BuildChangeSet}
      */
     public List<BuildChangeSetItem> getItems() {
         return items;
@@ -43,8 +43,8 @@ public String getKind() {
     }
 
     /**
-    *
-    */
+     * @param kind the kind of (usually svn, git).
+     */
     public void setKind(String kind) {
         this.kind = kind;
     }

jenkins-client/src/main/java/com/offbytwo/jenkins/model/BuildChangeSet.java

@@ -362,7 +362,7 @@ public String getConsoleOutputText() throws IOException {
      * The console output with HTML.
      * 
      * @return The console output as HTML.
-     * @throws IOException
+     * @throws IOException in case of an error.
      */
     public String getConsoleOutputHtml() throws IOException {
         return client.get(getUrl() + "/logText/progressiveHtml");

jenkins-client/src/main/java/com/offbytwo/jenkins/model/BuildWithDetails.java

@@ -63,7 +63,7 @@ public Boolean getLaunchSupported() {
      * (node) name.
      * 
      * @return {@link LoadStatistics}
-     * @throws IOException
+     * @throws IOException in case of an error.
      */
     public LoadStatistics getLoadStatistics() throws IOException {
         // TODO: Think about the following handling, cause that has also being

jenkins-client/src/main/java/com/offbytwo/jenkins/model/ComputerWithDetails.java

@@ -1,7 +1,9 @@
 package com.offbytwo.jenkins.model;
 
 /**
- * @author Adrien Lecharpentier <[email protected]>
+ * @author Adrien Lecharpentier
+ *         <a href="mailto:[email protected]">adrien.
+ *         [email protected]</a>
  */
 public class Crumb extends BaseModel {
 

jenkins-client/src/main/java/com/offbytwo/jenkins/model/Crumb.java

@@ -2,7 +2,9 @@
 
 /**
  * This class is based on informations which can be extracted from an running
- * Jenkins instance like this: {@link http://jenkins-server/computer/api/schema}
+ * Jenkins instance via
+ * <a href="http://jenkins-server/computer/api/schema">http://jenkins-server/
+ * computer/api/schema</a>.
  * 
  * @author Karl Heinz Marbaise
  *