poi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fannin...@apache.org
Subject svn commit: r1802035 - in /poi/trunk/src: java/org/apache/poi/hssf/record/cont/ java/org/apache/poi/hssf/usermodel/ java/org/apache/poi/poifs/crypt/ java/org/apache/poi/poifs/filesystem/ java/org/apache/poi/ss/util/ ooxml/java/org/apache/poi/xssf/userm...
Date Sat, 15 Jul 2017 22:31:10 GMT
Author: fanningpj
Date: Sat Jul 15 22:31:09 2017
New Revision: 1802035

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

Modified:
    poi/trunk/src/java/org/apache/poi/hssf/record/cont/ContinuableRecordInput.java
    poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
    poi/trunk/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
    poi/trunk/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java
    poi/trunk/src/java/org/apache/poi/ss/util/CellReference.java
    poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
    poi/trunk/src/testcases/org/apache/poi/ss/usermodel/BaseTestCell.java

Modified: poi/trunk/src/java/org/apache/poi/hssf/record/cont/ContinuableRecordInput.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/cont/ContinuableRecordInput.java?rev=1802035&r1=1802034&r2=1802035&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/cont/ContinuableRecordInput.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/cont/ContinuableRecordInput.java Sat Jul
15 22:31:09 2017
@@ -44,7 +44,7 @@ import org.apache.poi.util.LittleEndianI
  *
  * <p>
  * YK: For now (March 2011) this class is only used to read
- *   @link org.apache.poi.hssf.record.common.UnicodeString.ExtRst} blocks of a UnicodeString.
+ *   @see org.apache.poi.hssf.record.common.UnicodeString.ExtRst blocks of a UnicodeString.
  *
  * </p>
  */

Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java?rev=1802035&r1=1802034&r2=1802035&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java Sat Jul 15 22:31:09
2017
@@ -1025,7 +1025,7 @@ public final class HSSFWorkbook extends
 
     /**
      * Get the HSSFSheet object at the given index.
-     * @param index of the sheet number (0-based physical & logical)
+     * @param index of the sheet number (0-based physical &amp; logical)
      * @return HSSFSheet at the provided index
      * @throws IllegalArgumentException if the index is out of range (index
      *            &lt; 0 || index &gt;= getNumberOfSheets()).

Modified: poi/trunk/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java?rev=1802035&r1=1802034&r2=1802035&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java (original)
+++ poi/trunk/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java Sat Jul 15 22:31:09
2017
@@ -186,7 +186,7 @@ public class CryptoFunctions {
      * If the given algorithm is not implemented in the JCE, it will try to load it from
the bouncy castle
      * provider.
      *
-     * @param key the secrect key
+     * @param key the secret key
      * @param cipherAlgorithm the cipher algorithm
      * @param chain the chaining mode
      * @param vec the initialization vector (IV), can be null
@@ -205,7 +205,7 @@ public class CryptoFunctions {
      * If the given algorithm is not implemented in the JCE, it will try to load it from
the bouncy castle
      * provider.
      *
-     * @param key the secrect key
+     * @param key the secret key
      * @param cipherAlgorithm the cipher algorithm
      * @param chain the chaining mode
      * @param vec the initialization vector (IV), can be null

Modified: poi/trunk/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java?rev=1802035&r1=1802034&r2=1802035&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java (original)
+++ poi/trunk/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java Sat Jul 15 22:31:09
2017
@@ -229,8 +229,7 @@ public class POIFSDocumentPath
      *
      * @return the nth component;
      *
-     * @exception ArrayIndexOutOfBoundsException if n < 0 or n >=
-     *                                           length()
+     * @exception ArrayIndexOutOfBoundsException if n &lt; 0 or n >= length()
      */
 
     public String getComponent(int n)

Modified: poi/trunk/src/java/org/apache/poi/ss/util/CellReference.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/util/CellReference.java?rev=1802035&r1=1802034&r2=1802035&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/util/CellReference.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/util/CellReference.java Sat Jul 15 22:31:09 2017
@@ -185,10 +185,10 @@ public class CellReference {
     /**
      * takes in a column reference portion of a CellRef and converts it from
      * ALPHA-26 number format to 0-based base 10.
-     * 'A' -> 0
-     * 'Z' -> 25
-     * 'AA' -> 26
-     * 'IV' -> 255
+     * 'A' -&gt; 0
+     * 'Z' -&gt; 25
+     * 'AA' -&gt; 26
+     * 'IV' -&gt; 255
      * @return zero based column index
      */
     public static int convertColStringToIndex(String ref) {

Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java?rev=1802035&r1=1802034&r2=1802035&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java Sat Jul 15 22:31:09
2017
@@ -65,7 +65,6 @@ import org.apache.poi.ss.usermodel.DataV
 import org.apache.poi.ss.usermodel.Footer;
 import org.apache.poi.ss.usermodel.Header;
 import org.apache.poi.ss.usermodel.IgnoredErrorType;
-import org.apache.poi.ss.usermodel.IndexedColors;
 import org.apache.poi.ss.usermodel.Name;
 import org.apache.poi.ss.usermodel.Row;
 import org.apache.poi.ss.usermodel.Sheet;
@@ -1344,7 +1343,7 @@ public class XSSFSheet extends POIXMLDoc
     /**
      * Answer whether protection is enabled or disabled
      *
-     * @return true => protection enabled; false => protection disabled
+     * @return true =&gt; protection enabled; false =&gt; protection disabled
      */
     @Override
     public boolean getProtect() {
@@ -1548,7 +1547,7 @@ public class XSSFSheet extends POIXMLDoc
     /**
      * A flag indicating whether scenarios are locked when the sheet is protected.
      *
-     * @return true => protection enabled; false => protection disabled
+     * @return true =&gt; protection enabled; false =&gt; protection disabled
      */
     @Override
     public boolean getScenarioProtect() {
@@ -2477,7 +2476,7 @@ public class XSSFSheet extends POIXMLDoc
      *
      * @param columnIndex - the column to set (0-based)
      * @param width - the width in units of 1/256th of a character width
-     * @throws IllegalArgumentException if width > 255*256 (the maximum column width in
Excel is 255 characters)
+     * @throws IllegalArgumentException if width &gt; 255*256 (the maximum column width
in Excel is 255 characters)
      */
     @Override
     public void setColumnWidth(int columnIndex, int width) {
@@ -2768,7 +2767,7 @@ public class XSSFSheet extends POIXMLDoc
 
     /**
      * 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 &amp; Vertical scale together.
      *
      * For example:
      * <pre>
@@ -3899,7 +3898,6 @@ public class XSSFSheet extends POIXMLDoc
 
     }
 
-    @SuppressWarnings("resource")
     @Override
     public XSSFAutoFilter setAutoFilter(CellRangeAddress range) {
         CTAutoFilter af = worksheet.getAutoFilter();
@@ -4159,7 +4157,6 @@ public class XSSFSheet extends POIXMLDoc
      * including: pivotCacheDefinition, pivotCacheRecords
      * @return returns a pivotTable
      */
-    @SuppressWarnings("resource")
     @Beta
     private XSSFPivotTable createPivotTable() {
         XSSFWorkbook wb = getWorkbook();

Modified: poi/trunk/src/testcases/org/apache/poi/ss/usermodel/BaseTestCell.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/testcases/org/apache/poi/ss/usermodel/BaseTestCell.java?rev=1802035&r1=1802034&r2=1802035&view=diff
==============================================================================
--- poi/trunk/src/testcases/org/apache/poi/ss/usermodel/BaseTestCell.java (original)
+++ poi/trunk/src/testcases/org/apache/poi/ss/usermodel/BaseTestCell.java Sat Jul 15 22:31:09
2017
@@ -515,8 +515,8 @@ public abstract class BaseTestCell {
     }
     
     /**
-     * similar to {@link #testConvertStringFormulaCell()} but  checks at a
-     * lower level that {#link {@link Cell#setCellType(int)} works properly
+     * similar to {@link #testConvertStringFormulaCell()} but checks at a
+     * lower level that {#link {@link Cell#setCellType(CellType)} works properly
      */
     @Test
     public void testSetTypeStringOnFormulaCell() throws IOException {



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


Mime
View raw message