From fef756c96793163314569153e71172ebad3063be Mon Sep 17 00:00:00 2001 From: dragonmacher <48328597+dragonmacher@users.noreply.github.com> Date: Fri, 22 Jan 2021 09:58:17 -0500 Subject: [PATCH] GP-523 - Fix javadoc errors --- .../java/generic/concurrent/ConcurrentQ.java | 4 ++-- .../ghidra/pcode/floatformat/BigFloat.java | 24 ++++++++++++------- .../ghidra/pcode/floatformat/FloatFormat.java | 9 ++++--- .../program/model/address/AddressSetView.java | 4 ++-- gradle/root/distribution.gradle | 6 ++++- 5 files changed, 30 insertions(+), 17 deletions(-) diff --git a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java index 3fcff98639..f52b772549 100644 --- a/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java +++ b/Ghidra/Framework/Generic/src/main/java/generic/concurrent/ConcurrentQ.java @@ -114,8 +114,8 @@ import ghidra.util.task.TaskMonitor; * } * }; * - * QItemListener itemListener = new QItemListener() { - * public void itemProcessed(QResult result) { + * {@literal QItemListener itemListener = new QItemListener()} { + * {@literal public void itemProcessed(QResult result)} { * RESULT result = result.getResult(); * // work on my result... * } diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcode/floatformat/BigFloat.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcode/floatformat/BigFloat.java index f80938011f..78074b1d63 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcode/floatformat/BigFloat.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcode/floatformat/BigFloat.java @@ -15,7 +15,8 @@ */ package ghidra.pcode.floatformat; -import java.math.*; +import java.math.BigDecimal; +import java.math.BigInteger; /** * An IEEE 754 floating point class. @@ -94,12 +95,15 @@ public strictfp class BigFloat implements Comparable { @Override public boolean equals(Object obj) { - if (this == obj) + if (this == obj) { return true; - if (obj == null) + } + if (obj == null) { return false; - if (getClass() != obj.getClass()) + } + if (getClass() != obj.getClass()) { return false; + } BigFloat other = (BigFloat) obj; if (expbits != other.expbits) { return false; @@ -225,11 +229,12 @@ public strictfp class BigFloat implements Comparable { * This function is used internally to round after a computation. * *

Assume that the true value is - * sign * (unscaled + eps) * 2 ^ (scale-fracbits) + * 

   sign * (unscaled + eps) * 2 ^ (scale-fracbits)
 	 * and
-	 *    unscaled.bitLength() > fracbits+1
-	 *     (or the value is subnormal with at least 1 bit of extra precision)
-	 *  
+	 *   unscaled.bitLength() > fracbits+1 
+	 *
+	 * (or the value is subnormal with at least 1 bit of extra precision)
+	 *
* @param eps < 1 */ protected void internalRound(boolean eps) { @@ -320,8 +325,9 @@ public strictfp class BigFloat implements Comparable { case SIGNALING_NAN: return "sNaN"; case INFINITE: - if (sign < 0) + if (sign < 0) { return "-inf"; + } return "+inf"; case FINITE: String s = (sign < 0) ? "-" : ""; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcode/floatformat/FloatFormat.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcode/floatformat/FloatFormat.java index e0368f7074..f0d2b98687 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcode/floatformat/FloatFormat.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/pcode/floatformat/FloatFormat.java @@ -220,7 +220,9 @@ public strictfp class FloatFormat { // set sign bit and return the result if size <= 8 private long setSign(long x, boolean sign) { if (!sign) + { return x; // Assume bit is already zero + } long mask = 1; mask <<= signbit_pos; x |= mask; // Stick in the bit @@ -299,7 +301,7 @@ public strictfp class FloatFormat { /** * Decode {@code encoding} to a BigFloat using this format. * - * NB: this method should not be used if {@link #size}>8 + * NB: this method should not be used if {@link #size}>8 * * @param encoding the encoding * @return the decoded value as a BigFloat @@ -535,7 +537,7 @@ public strictfp class FloatFormat { /** * Convert an encoded value to a binary floating point representation. * - * NB: this method should not be used if {@link #size}>8 + * NB: this method should not be used if {@link #size}>8 * * @param encoding the encoding of a floating point value in this format * @return a binary string representation of the encoded floating point {@code encoding} @@ -548,8 +550,9 @@ public strictfp class FloatFormat { switch (kind) { case INFINITE: - if (sgn) + if (sgn) { return "-inf"; + } return "+inf"; case QUIET_NAN: return "qNaN"; diff --git a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetView.java b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetView.java index c832eaed3d..81aec8a393 100644 --- a/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetView.java +++ b/Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/model/address/AddressSetView.java @@ -242,7 +242,7 @@ public interface AddressSetView extends Iterable { /** * Trim address set removing all addresses less-than-or-equal to specified - * address based upon {@link Address#compareTo(Address)} behavior. + * address based upon {@link Address} comparison. * The address set may contain address ranges from multiple * address spaces. * @param set address set to be trimmed @@ -269,7 +269,7 @@ public interface AddressSetView extends Iterable { /** * Trim address set removing all addresses greater-than-or-equal to specified - * address based upon {@link Address#compareTo(Address)} behavior. + * address based upon {@link Address} comparison. * The address set may contain address ranges from multiple * address spaces. * @param set address set to be trimmed diff --git a/gradle/root/distribution.gradle b/gradle/root/distribution.gradle index dc6790e059..cd32b10fcf 100644 --- a/gradle/root/distribution.gradle +++ b/gradle/root/distribution.gradle @@ -125,6 +125,8 @@ task createJavadocs(type: Javadoc, description: 'Generate javadocs for all proje // generate documentation using html5 options.addBooleanOption("html5", true) + options.addBooleanOption('Xdoclint:none', true) + // Some internal packages are not public and need to be exported. options.addMultilineStringsOption("-add-exports").setValue(["java.desktop/sun.awt.image=ALL-UNNAMED", "java.desktop/sun.awt=ALL-UNNAMED", @@ -132,7 +134,8 @@ task createJavadocs(type: Javadoc, description: 'Generate javadocs for all proje "java.base/sun.security.provider=ALL-UNNAMED", "java.base/sun.security.util=ALL-UNNAMED"]) } - + + /********************************************************************************* * JSONDOCS - RAW * @@ -179,6 +182,7 @@ task createJsondocs(type: Javadoc, description: 'Generate JSON docs for all proj // Newer versions of gradle set this to true by default. // The JsonDoclet doesn't have the -notimestamp option so ensure it isn't set. options.setNoTimestamp(false) + // Some internal packages are not public and need to be exported. options.addMultilineStringsOption("-add-exports").setValue(["java.desktop/sun.awt.image=ALL-UNNAMED",