pashko/apache-poi
1
0
Fork 0
mirror of https://github.com/apache/poi.git synced 2026-02-27 20:40:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Adjust some JavaDoc

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1891344 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Dominik Stadler 2021-07-07 10:04:11 +00:00
parent d11e5ce48f
commit 5a1cb0ad90
4 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
poi/src/main/java/org/apache/poi/ddf/EscherShapePathProperty.java
View File

@ -30,6 +30,9 @@ public class EscherShapePathProperty extends EscherSimpleProperty {
/**
* Create an instance of an escher shape path property.
*
* @param propertyNumber which property to handle
* @param shapePath which shape path to handle
*/
public EscherShapePathProperty( short propertyNumber, int shapePath ) {
super( propertyNumber, false, false, shapePath );

4
poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java
View File

@ -217,7 +217,7 @@ public final class ExtractorFactory {
* no TextExtractor can be created for some reason.
*
* @throws IOException If converting the {@link DirectoryNode} into a HSSFWorkbook fails
* @throws OldFileFormatException If the {@link DirectoryNode} points to a format of
* @throws org.apache.poi.OldFileFormatException If the {@link DirectoryNode} points to a format of
* an unsupported version of Excel.
* @throws IllegalArgumentException If creating the Extractor fails
*/
@ -246,7 +246,7 @@ public final class ExtractorFactory {
* @return An array of resulting extractors. Empty if no embedded documents are found.
*
* @throws IOException If converting the {@link DirectoryNode} into a HSSFWorkbook fails
* @throws OldFileFormatException If the {@link DirectoryNode} points to a format of
* @throws org.apache.poi.OldFileFormatException If the {@link DirectoryNode} points to a format of
* an unsupported version of Excel.
* @throws IllegalArgumentException If creating the Extractor fails
*/

2
poi/src/main/java/org/apache/poi/hpsf/ClassID.java
View File

@ -68,6 +68,8 @@ public class ClassID implements Duplicatable, GenericRecord {
/**
* Clones the given ClassID
*
* @param other The ClassID to use a base for creating this one
*/
public ClassID(ClassID other) {
System.arraycopy(other.bytes, 0, bytes, 0, bytes.length);

5
poi/src/main/java/org/apache/poi/hssf/record/FormulaRecord.java
View File

@ -121,6 +121,8 @@ public final class FormulaRecord extends CellRecord {
}
/**
* @return The type of the cached value or CellType.NUMERIC.getCode() if the cached value is empty
*
* @deprecated POI 5.0.0, will be removed in 6.0, use getCachedResultTypeEnum until switch to enum is fully done
*/
@Deprecated
@ -134,7 +136,8 @@ public final class FormulaRecord extends CellRecord {
/**
* Returns the type of the cached result
* @return A CellType
*
* @return The type of the cached value or CellType.NUMERIC if the cached value is empty
* @since POI 5.0.0
*/
public CellType getCachedResultTypeEnum() {