mirror of https://github.com/apache/poi.git
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
This commit is contained in:
Marius Volkhart
parent
5730841488
commit
e239fd745f
|
|
@ -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}<p>
|
||||
* Defaults to {@code false}
|
||||
*
|
||||
* @param updateConfigOnValidate if true, update config on validate
|
||||
*
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
* <p>
|
||||
*
|
||||
* @param startRow the row to start shifting
|
||||
* @param endRow the row to end shifting
|
||||
* @param n the number of rows to shift
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
* <p>
|
||||
*
|
||||
* @param startRow the row to start shifting
|
||||
* @param endRow the row to end shifting
|
||||
* @param n the number of rows to shift
|
||||
|
|
|
|||
|
|
@ -502,7 +502,7 @@ public class DocumentSummaryInformation extends PropertySet {
|
|||
|
||||
|
||||
/**
|
||||
* Returns {@code true} if the custom links are dirty. <p>
|
||||
* Returns {@code true} if the custom links are dirty.
|
||||
*
|
||||
* @return The links dirty value
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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.<p>
|
||||
* always a multiple of 4 bytes is written.
|
||||
*
|
||||
* @param out The stream to write the value to.
|
||||
* @param type The variant's type.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
* </p>
|
||||
* Two attachments to <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=50779">Bugzilla 50779</a>
|
||||
* <p>
|
||||
* Two attachments to <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=50779">Bugzilla 50779</a>
|
||||
* demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character
|
||||
* or between two bytes of a <code>short</code>. 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 <code>ContinuableRecordInput</code>
|
||||
* class circumvents this "type boundary" rule and reads data byte-by-byte rolling over CONTINUE if necessary.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* YK: For now (March 2011) this class is only used to read
|
||||
* @see org.apache.poi.hssf.record.common.ExtRst blocks of a UnicodeString.
|
||||
*
|
||||
* </p>
|
||||
*/
|
||||
public class ContinuableRecordInput implements LittleEndianInput {
|
||||
private final RecordInputStream _in;
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
* <p>
|
||||
* We could overload this with convenience methods taking a sheet name and sheet index as well.
|
||||
* <p>
|
||||
*
|
||||
* @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}
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
* </p>
|
||||
*
|
||||
* <p>
|
||||
* The implementation is inspired by the NewtonSolver from the Apache Commons-Math library,
|
||||
* @see <a href="http://commons.apache.org">http://commons.apache.org</a>
|
||||
* </p>
|
||||
*
|
||||
*
|
||||
* @param values the income values.
|
||||
* @param guess the initial guess of irr.
|
||||
|
|
|
|||
|
|
@ -700,7 +700,7 @@ public interface Sheet extends Iterable<Row> {
|
|||
* 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.
|
||||
* <p>
|
||||
*
|
||||
* @param startRow the row to start shifting
|
||||
* @param endRow the row to end shifting
|
||||
* @param n the number of rows to shift
|
||||
|
|
|
|||
Loading…
Reference in New Issue