From e239fd745f19188c6e67d41f34f4ff730267888d Mon Sep 17 00:00:00 2001 From: Marius Volkhart Date: Fri, 1 Oct 2021 11:37:33 +0000 Subject: [PATCH] Fix Javadoc errors and warnings on JDK 17 git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1893777 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/poi/poifs/crypt/dsig/SignatureConfig.java | 2 +- .../java/org/apache/poi/xssf/streaming/SXSSFSheet.java | 2 +- .../java/org/apache/poi/xssf/usermodel/XSSFSheet.java | 2 +- .../org/apache/poi/hpsf/DocumentSummaryInformation.java | 2 +- poi/src/main/java/org/apache/poi/hpsf/VariantSupport.java | 2 +- .../poi/hssf/record/cont/ContinuableRecordInput.java | 8 ++------ .../poi/ss/formula/ConditionalFormattingEvaluator.java | 2 +- .../java/org/apache/poi/ss/formula/functions/Irr.java | 4 ++-- poi/src/main/java/org/apache/poi/ss/usermodel/Sheet.java | 2 +- 9 files changed, 11 insertions(+), 15 deletions(-) diff --git a/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureConfig.java b/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureConfig.java index 47a5350fd3..ccbdd517ac 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureConfig.java +++ b/poi-ooxml/src/main/java/org/apache/poi/poifs/crypt/dsig/SignatureConfig.java @@ -1044,7 +1044,7 @@ public class SignatureConfig { /** * The signature config can be updated if a document is succesful validated. * This flag is used for activating this modifications. - * Defaults to {@code false}

+ * Defaults to {@code false} * * @param updateConfigOnValidate if true, update config on validate * diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java index 7ba700682c..fd49ab5834 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java @@ -986,7 +986,7 @@ public class SXSSFSheet implements Sheet * Additionally shifts merged regions that are completely defined in these * rows (ie. merged 2 cells on a row to be shifted). All merged regions that are * completely overlaid by shifting will be deleted. - *

+ * * @param startRow the row to start shifting * @param endRow the row to end shifting * @param n the number of rows to shift diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java index a219f5c309..b383413e70 100644 --- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java +++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java @@ -2971,7 +2971,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * Additionally shifts merged regions that are completely defined in these * rows (ie. merged 2 cells on a row to be shifted). All merged regions that are * completely overlaid by shifting will be deleted. - *

+ * * @param startRow the row to start shifting * @param endRow the row to end shifting * @param n the number of rows to shift diff --git a/poi/src/main/java/org/apache/poi/hpsf/DocumentSummaryInformation.java b/poi/src/main/java/org/apache/poi/hpsf/DocumentSummaryInformation.java index 2621876c5a..9bd69be232 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/DocumentSummaryInformation.java +++ b/poi/src/main/java/org/apache/poi/hpsf/DocumentSummaryInformation.java @@ -502,7 +502,7 @@ public class DocumentSummaryInformation extends PropertySet { /** - * Returns {@code true} if the custom links are dirty.

+ * Returns {@code true} if the custom links are dirty. * * @return The links dirty value */ diff --git a/poi/src/main/java/org/apache/poi/hpsf/VariantSupport.java b/poi/src/main/java/org/apache/poi/hpsf/VariantSupport.java index 43f59357c7..e1720b66b1 100644 --- a/poi/src/main/java/org/apache/poi/hpsf/VariantSupport.java +++ b/poi/src/main/java/org/apache/poi/hpsf/VariantSupport.java @@ -262,7 +262,7 @@ public class VariantSupport extends Variant { /** * Writes a variant value to an output stream. This method ensures that - * always a multiple of 4 bytes is written.

+ * always a multiple of 4 bytes is written. * * @param out The stream to write the value to. * @param type The variant's type. diff --git a/poi/src/main/java/org/apache/poi/hssf/record/cont/ContinuableRecordInput.java b/poi/src/main/java/org/apache/poi/hssf/record/cont/ContinuableRecordInput.java index 0026aabaa8..5f50b584bc 100644 --- a/poi/src/main/java/org/apache/poi/hssf/record/cont/ContinuableRecordInput.java +++ b/poi/src/main/java/org/apache/poi/hssf/record/cont/ContinuableRecordInput.java @@ -31,8 +31,8 @@ import org.apache.poi.util.LittleEndianInput; * Most records construct themselves from {@link RecordInputStream}. * This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary, * however, it is not always so. - *

- * Two attachments to Bugzilla 50779 + *

+ * Two attachments to Bugzilla 50779 * demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character * or between two bytes of a short. The problematic portion of the data is * in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString. @@ -40,13 +40,9 @@ import org.apache.poi.util.LittleEndianInput; * {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a * "Not enough data (1) to read requested (2) bytes" exception. The ContinuableRecordInput * class circumvents this "type boundary" rule and reads data byte-by-byte rolling over CONTINUE if necessary. - *

- * *

* YK: For now (March 2011) this class is only used to read * @see org.apache.poi.hssf.record.common.ExtRst blocks of a UnicodeString. - * - *

*/ public class ContinuableRecordInput implements LittleEndianInput { private final RecordInputStream _in; diff --git a/poi/src/main/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java b/poi/src/main/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java index e8556c9a80..6113686336 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java @@ -246,7 +246,7 @@ public class ConditionalFormattingEvaluator { * The POI data model does not have a back-reference to the owning sheet, so it must be passed in separately. *

* We could overload this with convenience methods taking a sheet name and sheet index as well. - *

+ * * @param sheet containing the rule * @param conditionalFormattingIndex of the {@link ConditionalFormatting} instance in the sheet's array * @param ruleIndex of the {@link ConditionalFormattingRule} instance within the {@link ConditionalFormatting} diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/Irr.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/Irr.java index 16af5253bf..e9480c68c3 100644 --- a/poi/src/main/java/org/apache/poi/ss/formula/functions/Irr.java +++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/Irr.java @@ -74,11 +74,11 @@ public final class Irr implements Function { * Starting with the guess, the method cycles through the calculation until the result * is accurate within 0.00001 percent. If IRR can't find a result that works * after 20 tries, the {@code Double.NaN} is returned. - *

+ * *

* The implementation is inspired by the NewtonSolver from the Apache Commons-Math library, * @see http://commons.apache.org - *

+ * * * @param values the income values. * @param guess the initial guess of irr. diff --git a/poi/src/main/java/org/apache/poi/ss/usermodel/Sheet.java b/poi/src/main/java/org/apache/poi/ss/usermodel/Sheet.java index 1186207bba..fadbb6f48b 100644 --- a/poi/src/main/java/org/apache/poi/ss/usermodel/Sheet.java +++ b/poi/src/main/java/org/apache/poi/ss/usermodel/Sheet.java @@ -700,7 +700,7 @@ public interface Sheet extends Iterable { * Additionally shifts merged regions that are completely defined in these * rows (ie. merged 2 cells on a row to be shifted). All merged regions that are * completely overlaid by shifting will be deleted. - *

+ * * @param startRow the row to start shifting * @param endRow the row to end shifting * @param n the number of rows to shift