1
0
mirror of https://github.com/octoleo/plantuml.git synced 2025-01-03 15:17:23 +00:00

Get rid of some spammy javadoc warnings

This commit is contained in:
matthew16550 2021-12-01 13:49:41 +11:00
parent 1c11f505ae
commit b99f954128
7 changed files with 10 additions and 21 deletions

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -302,7 +302,7 @@ public class MTRandom extends Random {
* integer value. That is to say that: * integer value. That is to say that:
* <pre> * <pre>
* mt.setSeed(12345); * 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 * will not give the same result as
* <pre> * <pre>
* mt.setSeed(12345); * mt.setSeed(12345);