Author: fanningpj
Date: Wed Nov  3 14:00:10 2021
New Revision: 1894714

URL: http://svn.apache.org/viewvc?rev=1894714&view=rev
Log:
javadoc

Modified:
    
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java

Modified: 
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
URL: 
http://svn.apache.org/viewvc/poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java?rev=1894714&r1=1894713&r2=1894714&view=diff
==============================================================================
--- 
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java 
(original)
+++ 
poi/trunk/poi-ooxml/src/main/java/org/apache/poi/xssf/streaming/SXSSFSheet.java 
Wed Nov  3 14:00:10 2021
@@ -1051,7 +1051,14 @@ public class SXSSFSheet implements Sheet
 
     /**
      * Sets a page break at the indicated row
-     * @param row FIXME: Document this!
+     * Breaks occur above the specified row and left of the specified column 
inclusive.
+     *
+     * For example, {@code sheet.setColumnBreak(2);} breaks the sheet into two 
parts
+     * with columns A,B,C in the first and D,E,... in the second. Simuilar, 
{@code sheet.setRowBreak(2);}
+     * breaks the sheet into two parts with first three rows (rownum=1...3) in 
the first part
+     * and rows starting with rownum=4 in the second.
+     *
+     * @param row the row to break, inclusive
      */
     @Override
     public void setRowBreak(int row) {



---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to