summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPJ Fanning <fanningpj@apache.org>2022-07-16 10:05:38 +0000
committerPJ Fanning <fanningpj@apache.org>2022-07-16 10:05:38 +0000
commitfeae2c87490392f2e69212949a1e734e930e7e20 (patch)
tree3806b0c8f6865da3ed7c94c495f314e152e815d2
parent5b78069b6311678d7c80b18c6e9d7e1dff0fcd20 (diff)
downloadpoi-feae2c87490392f2e69212949a1e734e930e7e20.tar.gz
poi-feae2c87490392f2e69212949a1e734e930e7e20.zip
[github-346] Javadoc issues. Thanks to XenoAmess. This closes #346
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1902771 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--poi-ooxml/src/test/java/org/apache/poi/openxml4j/opc/TestContentType.java2
-rw-r--r--poi-ooxml/src/test/java/org/apache/poi/xssf/util/MemoryUsage.java7
-rw-r--r--poi/src/main/java/org/apache/poi/ss/util/MutableFPNumber.java4
-rw-r--r--poi/src/test/java/org/apache/poi/ss/formula/BaseTestExternalFunctions.java2
4 files changed, 6 insertions, 9 deletions
diff --git a/poi-ooxml/src/test/java/org/apache/poi/openxml4j/opc/TestContentType.java b/poi-ooxml/src/test/java/org/apache/poi/openxml4j/opc/TestContentType.java
index 7847507017..926fabad65 100644
--- a/poi-ooxml/src/test/java/org/apache/poi/openxml4j/opc/TestContentType.java
+++ b/poi-ooxml/src/test/java/org/apache/poi/openxml4j/opc/TestContentType.java
@@ -87,7 +87,7 @@ public final class TestContentType {
* Parameters are allowed, provides that they meet the
* criteria of rule [01.2]
* Invalid parameters are verified as incorrect in
- * {@link #testContentTypeParameterFailure()}
+ * {@link #testContentTypeParameterFailure(String)}
*/
@ParameterizedTest
@ValueSource(strings = {"mail/toto;titi=tata",
diff --git a/poi-ooxml/src/test/java/org/apache/poi/xssf/util/MemoryUsage.java b/poi-ooxml/src/test/java/org/apache/poi/xssf/util/MemoryUsage.java
index e7ba523ded..0492d299e0 100644
--- a/poi-ooxml/src/test/java/org/apache/poi/xssf/util/MemoryUsage.java
+++ b/poi-ooxml/src/test/java/org/apache/poi/xssf/util/MemoryUsage.java
@@ -53,7 +53,7 @@ public class MemoryUsage {
/**
* Generate a spreadsheet until OutOfMemoryError using low-level OOXML XmlBeans.
- * Similar to {@link #numberSpreadsheet(org.apache.poi.ss.usermodel.Workbook, int)}
+ * Similar to {@link #testNumberHSSF(boolean)} (org.apache.poi.ss.usermodel.Workbook, int)}
*
* <p>
*
@@ -171,12 +171,11 @@ public class MemoryUsage {
* Generate a spreadsheet who's all cell values are numbers.
* The data is generated until OutOfMemoryError.
* <p>
- * as compared to {@link #mixedSpreadsheet(org.apache.poi.ss.usermodel.Workbook, int)},
+ * as compared to {@link #testMixed},
* this method does not set string values and, hence, does not involve the Shared Strings Table.
* </p>
*
- * @param wb the workbook to write to
- * @param numCols the number of columns in a row
+ * @param useXSSF use XSSF as opposed to HSSF
*/
@ParameterizedTest
@ValueSource(booleans = {false, true})
diff --git a/poi/src/main/java/org/apache/poi/ss/util/MutableFPNumber.java b/poi/src/main/java/org/apache/poi/ss/util/MutableFPNumber.java
index 335446e7ae..dc4cd9b699 100644
--- a/poi/src/main/java/org/apache/poi/ss/util/MutableFPNumber.java
+++ b/poi/src/main/java/org/apache/poi/ss/util/MutableFPNumber.java
@@ -25,7 +25,7 @@ final class MutableFPNumber {
// TODO - what about values between (10<sup>14</sup>-0.5) and (10<sup>14</sup>-0.05) ?
/**
* The minimum value in 'Base-10 normalised form'.<br>
- * When {@link #_binaryExponent} == 46 this is the minimum {@link #_frac} value
+ * When {@link #_binaryExponent} == 46 this is the minimum {@link #_significand} value
* (10<sup>14</sup>-0.05) * 2^17
* <br>
* Values between (10<sup>14</sup>-0.05) and 10<sup>14</sup> will be represented as '1'
@@ -37,7 +37,7 @@ final class MutableFPNumber {
private static final BigInteger BI_MIN_BASE = new BigInteger("0B5E620F47FFFE666", 16);
/**
* For 'Base-10 normalised form'<br>
- * The maximum {@link #_frac} value when {@link #_binaryExponent} == 49
+ * The maximum {@link #_significand} value when {@link #_binaryExponent} == 49
* (10^15-0.5) * 2^14
*/
private static final BigInteger BI_MAX_BASE = new BigInteger("0E35FA9319FFFE000", 16);
diff --git a/poi/src/test/java/org/apache/poi/ss/formula/BaseTestExternalFunctions.java b/poi/src/test/java/org/apache/poi/ss/formula/BaseTestExternalFunctions.java
index 4e6bb88d4a..af6440a36e 100644
--- a/poi/src/test/java/org/apache/poi/ss/formula/BaseTestExternalFunctions.java
+++ b/poi/src/test/java/org/apache/poi/ss/formula/BaseTestExternalFunctions.java
@@ -132,8 +132,6 @@ public abstract class BaseTestExternalFunctions {
/**
* test invoking saved ATP functions
- *
- * @param testFile either atp.xls or atp.xlsx
*/
@Test
void baseTestInvokeATP() throws IOException {