aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominik Stadler <centic@apache.org>2019-05-16 11:40:38 +0000
committerDominik Stadler <centic@apache.org>2019-05-16 11:40:38 +0000
commitf4a3d3bb899fecaa0303a29d30e9552300bc32cb (patch)
tree5108e018c65625a7da375d6aedb2101276f1f9aa
parentb3da2d5e8a4779fc93dfe8750408a60836e15921 (diff)
downloadpoi-f4a3d3bb899fecaa0303a29d30e9552300bc32cb.tar.gz
poi-f4a3d3bb899fecaa0303a29d30e9552300bc32cb.zip
Refine JavaDoc of WorkbookFactory slightly
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1859368 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java b/src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
index 157dcb50b1..f94850147a 100644
--- a/src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
+++ b/src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
@@ -52,7 +52,7 @@ public class WorkbookFactory {
*
* @return The created workbook
*
- * @throws IOException if an error occurs while reading the data
+ * @throws IOException if an error occurs while creating the objects
*/
public static Workbook create(boolean xssf) throws IOException {
if(xssf) {
@@ -160,13 +160,14 @@ public class WorkbookFactory {
* <p>Note that in order to properly release resources the
* Workbook should be closed after use.</p>
*
- * @param pkg The {@link org.apache.poi.openxml4j.opc.OPCPackage} opened for reading data.
+ * @param pkg The org.apache.poi.openxml4j.opc.OPCPackage opened for reading data.
*
* @return The created Workbook
*
* @throws IOException if an error occurs while reading the data
*
- * @deprecated use XSSFWorkbookFactory.create
+ * @deprecated use {@link #create(File)}, {@link #create(InputStream)} or
+ * XSSFWorkbookFactory.create(OPCPackage) instead.
*/
@Deprecated
@Removal(version = "4.2.0")