Merge pull request #815 from matthew16550/clean-javadoc

Remove javadoc spam from build logs

pom.xml

@@ -190,7 +190,7 @@
       </plugin>
       <plugin>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.2.0</version>
+        <version>3.3.1</version>
         <executions>
           <execution>
             <id>attach-javadocs</id>
@@ -198,9 +198,9 @@
               <goal>jar</goal>
             </goals>
             <configuration>
-              <javadoc.opts>-Xdoclint:none</javadoc.opts>
-              <additionalparam>-Xdoclint:none</additionalparam>
               <doclint>none</doclint>
+              <quiet>true</quiet>
+              <sourceFileIncludes>net/sourceforge/plantuml/**/*.java</sourceFileIncludes>
             </configuration>
           </execution>
         </executions>

src/net/sourceforge/plantuml/code/deflate/CanonicalCode.java

@@ -83,7 +83,7 @@ final class CanonicalCode {
 	 *   <li>[1, 1, 1] (result: A=0, B=1, C=overflow)</li>
 	 *   <li>[1, 1, 2, 2, 3, 3, 3, 3] (result: A=0, B=1, C=overflow, ...)</li>
 	 * </ul>
-	 * @param canonicalCodeLengths array of symbol code lengths (not {@code null})
+	 * @param codeLengths array of symbol code lengths (not {@code null})
 	 * @throws NullPointerException if the array is {@code null}
 	 * @throws IllegalArgumentException if any element is negative, any value exceeds MAX_CODE_LENGTH,
 	 * or the collection of code lengths would yield an under-full or over-full Huffman code tree

src/net/sourceforge/plantuml/core/Diagram.java

@@ -86,15 +86,11 @@ public interface Diagram {
 
 	/**
 	 * The original source of the diagram
-	 * 
-	 * @return
 	 */
 	UmlSource getSource();
 
 	/**
 	 * Check if the Diagram have some links.
-	 * 
-	 * @return
 	 */
 	public boolean hasUrl();
 

src/net/sourceforge/plantuml/core/ImageData.java

@@ -51,13 +51,11 @@ public interface ImageData {
 
 	/**
 	 * Width in pixel of the image.
-	 * @return
 	 */
 	public int getWidth();
 
 	/**
 	 * Height in pixel of the image.
-	 * @return
 	 */
 	public int getHeight();
 
@@ -79,7 +77,6 @@ public interface ImageData {
 	 * </code>
 	 * 
 	 * @param nameId the id to be used in the cmap data string.
-	 * @return
 	 */
 	public String getCMapData(String nameId);
 	

src/net/sourceforge/plantuml/core/UmlSource.java

@@ -36,8 +36,6 @@
 package net.sourceforge.plantuml.core;
 
 import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Iterator;
 import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -193,8 +191,6 @@ final public class UmlSource {
 
 	/**
 	 * Return the number of line in the diagram.
-	 * 
-	 * @return
 	 */
 	public int getTotalLineCount() {
 		return source.size();
@@ -231,8 +227,6 @@ final public class UmlSource {
 	/**
 	 * Retrieve the title, if defined in the diagram source. Never return
 	 * <code>null</code>.
-	 * 
-	 * @return
 	 */
 	public Display getTitle() {
 		final Pattern2 p = MyPattern.cmpile("^[%s]*title[%s]+(.+)$");

src/net/sourceforge/plantuml/sequencediagram/graphic/LivingParticipantBox.java

@@ -53,6 +53,7 @@ public class LivingParticipantBox implements InGroupable {
 	/**
 	 * @deprecated a virer
 	 */
+	@Deprecated
 	public ParticipantBox getParticipantBox() {
 		return participantBox;
 	}
@@ -60,6 +61,7 @@ public class LivingParticipantBox implements InGroupable {
 	/**
 	 * @deprecated a virer
 	 */
+	@Deprecated
 	public LifeLine getLifeLine() {
 		return lifeLine;
 	}

src/net/sourceforge/plantuml/ugraphic/color/HSLColor.java

@@ -279,7 +279,7 @@ public class HSLColor {
 	 *
 	 * @param hsl an array containing the 3 HSL values
 	 *
-	 * @returns the RGB Color object
+	 * @return the RGB Color object
 	 */
 	public static Color toRGB(float[] hsl) {
 		return toRGB(hsl, 1.0f);
@@ -293,7 +293,7 @@ public class HSLColor {
 	 * @param hsl   an array containing the 3 HSL values
 	 * @param alpha the alpha value between 0 - 1
 	 *
-	 * @returns the RGB Color object
+	 * @return the RGB Color object
 	 */
 	public static Color toRGB(float[] hsl, float alpha) {
 		return toRGB(hsl[0], hsl[1], hsl[2], alpha);
@@ -306,7 +306,7 @@ public class HSLColor {
 	 * @param s Saturation is specified as a percentage in the range 1 - 100.
 	 * @param l Lumanance is specified as a percentage in the range 1 - 100.
 	 *
-	 * @returns the RGB Color object
+	 * @return the RGB Color object
 	 */
 	public static Color toRGB(float h, float s, float l) {
 		return toRGB(h, s, l, 1.0f);
@@ -320,7 +320,7 @@ public class HSLColor {
 	 * @param l     Lumanance is specified as a percentage in the range 1 - 100.
 	 * @param alpha the alpha value between 0 - 1
 	 *
-	 * @returns the RGB Color object
+	 * @return the RGB Color object
 	 */
 	public static Color toRGB(float h, float s, float l, float alpha) {
 		if (s < 0.0f || s > 100.0f) {
@@ -386,4 +386,4 @@ public class HSLColor {
 
 		return p;
 	}
-}
+}

src/net/sourceforge/plantuml/utils/MTRandom.java

@@ -302,7 +302,7 @@ public class MTRandom extends Random {
 	 * integer value.  That is to say that:
 	 * <pre>
 	 * mt.setSeed(12345);
-	 * int foo = mt.nextInt(16) + (mt.nextInt(16) << 16);</pre>
+	 * int foo = mt.nextInt(16) + (mt.nextInt(16) &lt;&lt; 16);</pre>
 	 * will not give the same result as
 	 * <pre>
 	 * mt.setSeed(12345);
@@ -387,4 +387,4 @@ public class MTRandom extends Random {
 		}
 		return ibuf;
 	}
-}
+}