diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java index 698e20a06..b1cf0fced 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java @@ -1386,9 +1386,8 @@ public final class HSSFSheet implements org.apache.poi.ss.usermodel.Sheet { * * @param numerator The numerator for the zoom magnification. * @param denominator The denominator for the zoom magnification. - * @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #setZoom(int)} instead. + * @see #setZoom(int) */ - @Override public void setZoom(int numerator, int denominator) { if (numerator < 1 || numerator > 65535) throw new IllegalArgumentException("Numerator must be greater than 0 and less than 65536"); diff --git a/src/java/org/apache/poi/ss/usermodel/Sheet.java b/src/java/org/apache/poi/ss/usermodel/Sheet.java index 34521fd43..3c064600b 100644 --- a/src/java/org/apache/poi/ss/usermodel/Sheet.java +++ b/src/java/org/apache/poi/ss/usermodel/Sheet.java @@ -25,6 +25,7 @@ import java.util.Map; import org.apache.poi.ss.util.CellAddress; import org.apache.poi.ss.util.CellRangeAddress; import org.apache.poi.ss.util.PaneInformation; +import org.apache.poi.util.Removal; /** * High level representation of a Excel worksheet. @@ -624,6 +625,7 @@ public interface Sheet extends Iterable { * @param denominator The denominator for the zoom magnification. * @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #setZoom(int)} instead. */ + @Removal(version="3.16") @Deprecated void setZoom(int numerator, int denominator); diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java index d87d4d9b6..db75ca6d5 100644 --- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java +++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java @@ -47,6 +47,7 @@ import org.apache.poi.ss.util.PaneInformation; import org.apache.poi.ss.util.SheetUtil; import org.apache.poi.util.Internal; import org.apache.poi.util.NotImplemented; +import org.apache.poi.util.Removal; import org.apache.poi.xssf.usermodel.XSSFColor; import org.apache.poi.xssf.usermodel.XSSFComment; import org.apache.poi.xssf.usermodel.XSSFDataValidation; @@ -771,7 +772,7 @@ public class SXSSFSheet implements Sheet /** * Gets the user model for the default document header. - *

+ *

* Note that XSSF offers more kinds of document headers than HSSF does *

* @return the document header. Never null @@ -784,9 +785,9 @@ public class SXSSFSheet implements Sheet /** * Gets the user model for the default document footer. - *

+ *

* Note that XSSF offers more kinds of document footers than HSSF does. - * + *

* @return the document footer. Never null */ @Override @@ -797,9 +798,9 @@ public class SXSSFSheet implements Sheet /** * Sets a flag indicating whether this sheet is selected. - *

+ *

* Note: multiple sheets can be selected, but only one sheet can be active at one time. - *

+ *

* @param value true if this sheet is selected * @see Workbook#setActiveSheet(int) */ @@ -836,7 +837,7 @@ public class SXSSFSheet implements Sheet /** * Answer whether protection is enabled or disabled * - * @return true => protection enabled; false => protection disabled + * @return true means protection enabled; false means protection disabled */ @Override public boolean getProtect() @@ -857,7 +858,7 @@ public class SXSSFSheet implements Sheet /** * Answer whether scenario protection is enabled or disabled * - * @return true => protection enabled; false => protection disabled + * @return true means protection enabled; false means protection disabled */ @Override public boolean getScenarioProtect() @@ -866,7 +867,7 @@ public class SXSSFSheet implements Sheet } /** - * Sets the zoom magnication for the sheet. The zoom is expressed as a + * Sets the zoom magnification for the sheet. The zoom is expressed as a * fraction. For example to express a zoom of 75% use 3 for the numerator * and 4 for the denominator. * @@ -874,6 +875,7 @@ public class SXSSFSheet implements Sheet * @param denominator The denominator for the zoom magnification. * @deprecated 2015-11-23 (circa POI 3.14beta1). Use {@link #setZoom(int)} instead. */ + @Removal(version="3.16") @Override public void setZoom(int numerator, int denominator) { @@ -882,7 +884,7 @@ public class SXSSFSheet implements Sheet /** * Window zoom magnification for current view representing percent values. - * Valid values range from 10 to 400. Horizontal & Vertical scale together. + * Valid values range from 10 to 400. Horizontal and Vertical scale together. * * For example: * 
@@ -1308,7 +1310,7 @@ public class SXSSFSheet implements Sheet
      * 

      *
      * @param rownum    index of row to update (0-based)
-     * @param level     outline level (> 0)
+     * @param level     outline level (greater than 0)
      */
     public void setRowOutlineLevel(int rownum, int level)
     {
diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
index 8188c9e72..6993579cc 100644
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
@@ -82,11 +82,11 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook;
  */
 public class SXSSFWorkbook implements Workbook {
     /**
-     * Specifies how many rows can be accessed at most via getRow().
-     * When a new node is created via createRow() and the total number
+     * Specifies how many rows can be accessed at most via {@link SXSSFSheet#getRow}.
+     * When a new node is created via {@link SXSSFSheet#createRow} and the total number
      * of unflushed records would exceed the specified value, then the
      * row with the lowest index value is flushed and cannot be accessed
-     * via getRow() anymore.
+     * via {@link SXSSFSheet#getRow} anymore.
      */
     public static final int DEFAULT_WINDOW_SIZE = 100;
     private static final POILogger logger = POILogFactory.getLogger(SXSSFWorkbook.class);
@@ -116,8 +116,8 @@ public class SXSSFWorkbook implements Workbook {
     }
 
     /**
-     * Construct a workbook from a template.
-     * 

+     * 
Construct a workbook from a template.

+     * 
      * There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) :
      * 
    
      *   
  1. 
@@ -126,7 +126,7 @@ public class SXSSFWorkbook implements Workbook {
      *   
    2. 
      *   
  2. 
      *       Append rows to existing sheets. The row number MUST be greater
-     *       than max(rownum) in the template sheet.
+     *       than {@code max(rownum)} in the template sheet.
      *   
    3. 
      *   
  3. 
      *       Use existing workbook as a template and re-use global objects such
@@ -134,13 +134,13 @@ public class SXSSFWorkbook implements Workbook {
      *   
    4. 
      * 

      * All three use cases can work in a combination.
-     * 

+     * 
      * What is not supported:
      *