From 1c11f505aea998143d43b6e90bd9d71cebe0df3a Mon Sep 17 00:00:00 2001 From: matthew16550 Date: Wed, 1 Dec 2021 21:03:35 +1100 Subject: [PATCH 1/2] Bump maven-javadoc-plugin to 3.3.1 Only make javadoc from src/net/sourceforge/plantuml/* Set quiet=true to remove build log spam Remove outdated settings --- pom.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pom.xml b/pom.xml index e2368b5ad..75acfd1ed 100644 --- a/pom.xml +++ b/pom.xml @@ -190,7 +190,7 @@ maven-javadoc-plugin - 3.2.0 + 3.3.1 attach-javadocs @@ -198,9 +198,9 @@ jar - -Xdoclint:none - -Xdoclint:none none + true + net/sourceforge/plantuml/**/*.java From b99f954128cdaea28bb6c9c4fb4a7791baadb928 Mon Sep 17 00:00:00 2001 From: matthew16550 Date: Wed, 1 Dec 2021 13:49:41 +1100 Subject: [PATCH 2/2] Get rid of some spammy javadoc warnings --- .../plantuml/code/deflate/CanonicalCode.java | 2 +- src/net/sourceforge/plantuml/core/Diagram.java | 4 ---- src/net/sourceforge/plantuml/core/ImageData.java | 3 --- src/net/sourceforge/plantuml/core/UmlSource.java | 6 ------ .../sequencediagram/graphic/LivingParticipantBox.java | 2 ++ .../sourceforge/plantuml/ugraphic/color/HSLColor.java | 10 +++++----- src/net/sourceforge/plantuml/utils/MTRandom.java | 4 ++-- 7 files changed, 10 insertions(+), 21 deletions(-) diff --git a/src/net/sourceforge/plantuml/code/deflate/CanonicalCode.java b/src/net/sourceforge/plantuml/code/deflate/CanonicalCode.java index bfe21cf70..e5d923e5f 100644 --- a/src/net/sourceforge/plantuml/code/deflate/CanonicalCode.java +++ b/src/net/sourceforge/plantuml/code/deflate/CanonicalCode.java @@ -83,7 +83,7 @@ final class CanonicalCode { *
  • [1, 1, 1] (result: A=0, B=1, C=overflow)
    • *
  • [1, 1, 2, 2, 3, 3, 3, 3] (result: A=0, B=1, C=overflow, ...)
    • * - * @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 diff --git a/src/net/sourceforge/plantuml/core/Diagram.java b/src/net/sourceforge/plantuml/core/Diagram.java index cf9ec20fd..bf40080fe 100644 --- a/src/net/sourceforge/plantuml/core/Diagram.java +++ b/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(); diff --git a/src/net/sourceforge/plantuml/core/ImageData.java b/src/net/sourceforge/plantuml/core/ImageData.java index 14c961812..7910c6536 100644 --- a/src/net/sourceforge/plantuml/core/ImageData.java +++ b/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 { * * * @param nameId the id to be used in the cmap data string. - * @return */ public String getCMapData(String nameId); diff --git a/src/net/sourceforge/plantuml/core/UmlSource.java b/src/net/sourceforge/plantuml/core/UmlSource.java index a86298ace..336893922 100644 --- a/src/net/sourceforge/plantuml/core/UmlSource.java +++ b/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 * null. - * - * @return */ public Display getTitle() { final Pattern2 p = MyPattern.cmpile("^[%s]*title[%s]+(.+)$"); diff --git a/src/net/sourceforge/plantuml/sequencediagram/graphic/LivingParticipantBox.java b/src/net/sourceforge/plantuml/sequencediagram/graphic/LivingParticipantBox.java index fe3ef6fa9..f26e580f1 100644 --- a/src/net/sourceforge/plantuml/sequencediagram/graphic/LivingParticipantBox.java +++ b/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; } diff --git a/src/net/sourceforge/plantuml/ugraphic/color/HSLColor.java b/src/net/sourceforge/plantuml/ugraphic/color/HSLColor.java index 88abb36f1..2938a9dea 100644 --- a/src/net/sourceforge/plantuml/ugraphic/color/HSLColor.java +++ b/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; } -} \ No newline at end of file +} diff --git a/src/net/sourceforge/plantuml/utils/MTRandom.java b/src/net/sourceforge/plantuml/utils/MTRandom.java index f58740795..f305166c4 100644 --- a/src/net/sourceforge/plantuml/utils/MTRandom.java +++ b/src/net/sourceforge/plantuml/utils/MTRandom.java @@ -302,7 +302,7 @@ public class MTRandom extends Random { * integer value. That is to say that: * 
     	 * mt.setSeed(12345);
-	 * int foo = mt.nextInt(16) + (mt.nextInt(16) << 16);
    + * int foo = mt.nextInt(16) + (mt.nextInt(16) << 16); * will not give the same result as * 
     	 * mt.setSeed(12345);
@@ -387,4 +387,4 @@ public class MTRandom extends Random {
 		}
 		return ibuf;
 	}
-}
\ No newline at end of file
+}