GP-523 - Fix javadoc errors

This commit is contained in:
dragonmacher 2021-01-22 09:58:17 -05:00 committed by ghidra1
parent 3426df3ba5
commit fef756c967
5 changed files with 30 additions and 17 deletions

View File

@ -114,8 +114,8 @@ import ghidra.util.task.TaskMonitor;
* } * }
* }; * };
* *
* QItemListener<ITEM, RESULT> itemListener = new QItemListener<ITEM, RESULT>() { * {@literal QItemListener<ITEM, RESULT> itemListener = new QItemListener<ITEM, RESULT>()} {
* public void itemProcessed(QResult<ITEM, RESULT> result) { * {@literal public void itemProcessed(QResult<ITEM, RESULT> result)} {
* RESULT result = result.getResult(); * RESULT result = result.getResult();
* // work on my result... * // work on my result...
* } * }

View File

@ -15,7 +15,8 @@
*/ */
package ghidra.pcode.floatformat; package ghidra.pcode.floatformat;
import java.math.*; import java.math.BigDecimal;
import java.math.BigInteger;
/** /**
* An IEEE 754 floating point class. * An IEEE 754 floating point class.
@ -94,12 +95,15 @@ public strictfp class BigFloat implements Comparable<BigFloat> {
@Override @Override
public boolean equals(Object obj) { public boolean equals(Object obj) {
if (this == obj) if (this == obj) {
return true; return true;
if (obj == null) }
if (obj == null) {
return false; return false;
if (getClass() != obj.getClass()) }
if (getClass() != obj.getClass()) {
return false; return false;
}
BigFloat other = (BigFloat) obj; BigFloat other = (BigFloat) obj;
if (expbits != other.expbits) { if (expbits != other.expbits) {
return false; return false;
@ -225,11 +229,12 @@ public strictfp class BigFloat implements Comparable<BigFloat> {
* This function is used internally to round after a computation. * This function is used internally to round after a computation.
* *
* <p>Assume that the true value is * <p>Assume that the true value is
* <code>sign * (unscaled + eps) * 2 ^ (scale-fracbits)</code> * <pre> sign * (unscaled + eps) * 2 ^ (scale-fracbits)
* and * and
* <code>unscaled.bitLength() > fracbits+1</code> * unscaled.bitLength() &gt; fracbits+1
* (or the value is subnormal with at least 1 bit of extra precision) *
* * (or the value is subnormal with at least 1 bit of extra precision)
* </pre>
* @param eps &lt; 1 * @param eps &lt; 1
*/ */
protected void internalRound(boolean eps) { protected void internalRound(boolean eps) {
@ -320,8 +325,9 @@ public strictfp class BigFloat implements Comparable<BigFloat> {
case SIGNALING_NAN: case SIGNALING_NAN:
return "sNaN"; return "sNaN";
case INFINITE: case INFINITE:
if (sign < 0) if (sign < 0) {
return "-inf"; return "-inf";
}
return "+inf"; return "+inf";
case FINITE: case FINITE:
String s = (sign < 0) ? "-" : ""; String s = (sign < 0) ? "-" : "";

View File

@ -220,7 +220,9 @@ public strictfp class FloatFormat {
// set sign bit and return the result if size <= 8 // set sign bit and return the result if size <= 8
private long setSign(long x, boolean sign) { private long setSign(long x, boolean sign) {
if (!sign) if (!sign)
{
return x; // Assume bit is already zero return x; // Assume bit is already zero
}
long mask = 1; long mask = 1;
mask <<= signbit_pos; mask <<= signbit_pos;
x |= mask; // Stick in the bit x |= mask; // Stick in the bit
@ -299,7 +301,7 @@ public strictfp class FloatFormat {
/** /**
* Decode {@code encoding} to a BigFloat using this format. * 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}&gt;8
* *
* @param encoding the encoding * @param encoding the encoding
* @return the decoded value as a BigFloat * @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. * 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}&gt;8
* *
* @param encoding the encoding of a floating point value in this format * @param encoding the encoding of a floating point value in this format
* @return a binary string representation of the encoded floating point {@code encoding} * @return a binary string representation of the encoded floating point {@code encoding}
@ -548,8 +550,9 @@ public strictfp class FloatFormat {
switch (kind) { switch (kind) {
case INFINITE: case INFINITE:
if (sgn) if (sgn) {
return "-inf"; return "-inf";
}
return "+inf"; return "+inf";
case QUIET_NAN: case QUIET_NAN:
return "qNaN"; return "qNaN";

View File

@ -242,7 +242,7 @@ public interface AddressSetView extends Iterable<AddressRange> {
/** /**
* Trim address set removing all addresses less-than-or-equal to specified * 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 * The address set may contain address ranges from multiple
* address spaces. * address spaces.
* @param set address set to be trimmed * @param set address set to be trimmed
@ -269,7 +269,7 @@ public interface AddressSetView extends Iterable<AddressRange> {
/** /**
* Trim address set removing all addresses greater-than-or-equal to specified * 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 * The address set may contain address ranges from multiple
* address spaces. * address spaces.
* @param set address set to be trimmed * @param set address set to be trimmed

View File

@ -125,6 +125,8 @@ task createJavadocs(type: Javadoc, description: 'Generate javadocs for all proje
// generate documentation using html5 // generate documentation using html5
options.addBooleanOption("html5", true) options.addBooleanOption("html5", true)
options.addBooleanOption('Xdoclint:none', true)
// Some internal packages are not public and need to be exported. // Some internal packages are not public and need to be exported.
options.addMultilineStringsOption("-add-exports").setValue(["java.desktop/sun.awt.image=ALL-UNNAMED", options.addMultilineStringsOption("-add-exports").setValue(["java.desktop/sun.awt.image=ALL-UNNAMED",
"java.desktop/sun.awt=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.provider=ALL-UNNAMED",
"java.base/sun.security.util=ALL-UNNAMED"]) "java.base/sun.security.util=ALL-UNNAMED"])
} }
/********************************************************************************* /*********************************************************************************
* JSONDOCS - RAW * 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. // Newer versions of gradle set this to true by default.
// The JsonDoclet doesn't have the -notimestamp option so ensure it isn't set. // The JsonDoclet doesn't have the -notimestamp option so ensure it isn't set.
options.setNoTimestamp(false) options.setNoTimestamp(false)
// Some internal packages are not public and need to be exported. // Some internal packages are not public and need to be exported.
options.addMultilineStringsOption("-add-exports").setValue(["java.desktop/sun.awt.image=ALL-UNNAMED", options.addMultilineStringsOption("-add-exports").setValue(["java.desktop/sun.awt.image=ALL-UNNAMED",