From 5a1cb0ad9066676b868669d1d0a9507ed4b8ea48 Mon Sep 17 00:00:00 2001
From: Dominik Stadler <centic@apache.org>
Date: Wed, 7 Jul 2021 10:04:11 +0000
Subject: [PATCH] Adjust some JavaDoc

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1891344 13f79535-47bb-0310-9956-ffa450edef68
---
 .../java/org/apache/poi/ddf/EscherShapePathProperty.java     | 3 +++
 .../main/java/org/apache/poi/extractor/ExtractorFactory.java | 4 ++--
 poi/src/main/java/org/apache/poi/hpsf/ClassID.java           | 2 ++
 .../main/java/org/apache/poi/hssf/record/FormulaRecord.java  | 5 ++++-
 4 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/poi/src/main/java/org/apache/poi/ddf/EscherShapePathProperty.java b/poi/src/main/java/org/apache/poi/ddf/EscherShapePathProperty.java
index fd8da317f7..833d4ef19d 100644
--- a/poi/src/main/java/org/apache/poi/ddf/EscherShapePathProperty.java
+++ b/poi/src/main/java/org/apache/poi/ddf/EscherShapePathProperty.java
@@ -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 );
diff --git a/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java b/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java
index b804ec9fd5..73a293378f 100644
--- a/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java
+++ b/poi/src/main/java/org/apache/poi/extractor/ExtractorFactory.java
@@ -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
          */
diff --git a/poi/src/main/java/org/apache/poi/hpsf/ClassID.java b/poi/src/main/java/org/apache/poi/hpsf/ClassID.java
index f2c76c6c1d..81430cbbe4 100644
--- a/poi/src/main/java/org/apache/poi/hpsf/ClassID.java
+++ b/poi/src/main/java/org/apache/poi/hpsf/ClassID.java
@@ -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);
diff --git a/poi/src/main/java/org/apache/poi/hssf/record/FormulaRecord.java b/poi/src/main/java/org/apache/poi/hssf/record/FormulaRecord.java
index e42dcb6a6b..b0c3178f4e 100644
--- a/poi/src/main/java/org/apache/poi/hssf/record/FormulaRecord.java
+++ b/poi/src/main/java/org/apache/poi/hssf/record/FormulaRecord.java
@@ -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() {
-- 
2.39.5