svn commit: r1859368 - /poi/trunk/src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java

[ce...@apache.org]

Author: centic
Date: Thu May 16 11:40:38 2019
New Revision: 1859368

URL: http://svn.apache.org/viewvc?rev=1859368&view=rev
Log:
Refine JavaDoc of WorkbookFactory slightly

Modified:
    poi/trunk/src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java

Modified: poi/trunk/src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java?rev=1859368&r1=1859367&r2=1859368&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/usermodel/WorkbookFactory.java Thu May 16 11:40:38 2019
@@ -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")



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org