javadoc

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1894096 13f79535-47bb-0310-9956-ffa450edef68

poi/src/main/java/org/apache/poi/ss/usermodel/WorkbookFactory.java

@@ -73,9 +73,9 @@ public final class WorkbookFactory {
     }
 
     /**
-     * Creates a HSSFWorkbook from the given POIFSFileSystem<p>
+     * Creates a Workbook from the given POIFSFileSystem.
      *
-     * Note that in order to properly release resources the
+     * <p>Note that in order to properly release resources the
      * Workbook should be closed after use.
      *
      * @param fs The {@link POIFSFileSystem} to read the document from
@@ -90,7 +90,10 @@ public final class WorkbookFactory {
 
     /**
      * Creates a Workbook from the given POIFSFileSystem, which may
-     *  be password protected
+     *  be password protected.
+     *
+     * <p>Note that in order to properly release resources the
+     * Workbook should be closed after use.
      *
      *  @param fs The {@link POIFSFileSystem} to read the document from
      *  @param password The password that should be used or null if no password is necessary.
@@ -107,6 +110,9 @@ public final class WorkbookFactory {
     /**
      * Creates a Workbook from the given DirectoryNode.
      *
+     * <p>Note that in order to properly release resources the
+     * Workbook should be closed after use.
+     *
      * @param root The {@link DirectoryNode} to start reading the document from
      *
      * @return The created Workbook
@@ -120,7 +126,10 @@ public final class WorkbookFactory {
 
     /**
      * Creates a Workbook from the given DirectoryNode, which may
-     * be password protected
+     * be password protected.
+     *
+     * <p>Note that in order to properly release resources the
+     * Workbook should be closed after use.
      *
      * @param root The {@link DirectoryNode} to start reading the document from
      * @param password The password that should be used or null if no password is necessary.