Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

some javadoc fixes 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1802035 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
PJ Fanning 2017-07-15 22:31:09 +00:00
parent f9d5a16ca6
commit 69cc48aa85
7 changed files with 15 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/java/org/apache/poi/hssf/record/cont/ContinuableRecordInput.java
View File

@ -44,7 +44,7 @@ import org.apache.poi.util.LittleEndianInput;
*
* <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>
*/

2
src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
View File

@ -1025,7 +1025,7 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss
/**
* 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()).

4
src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
View File

@ -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

3
src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java
View File

@ -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)

8
src/java/org/apache/poi/ss/util/CellReference.java
View File

@ -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) {

11
src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
View File

@ -65,7 +65,6 @@ import org.apache.poi.ss.usermodel.DataValidationHelper;
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 POIXMLDocumentPart implements Sheet {
/**
* 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 POIXMLDocumentPart implements Sheet {
/**
* 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 POIXMLDocumentPart implements Sheet {
*
* @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 POIXMLDocumentPart 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 &amp; Vertical scale together.
*
* For example:
* <pre>
@ -3899,7 +3898,6 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet {
}
@SuppressWarnings("resource")
@Override
public XSSFAutoFilter setAutoFilter(CellRangeAddress range) {
CTAutoFilter af = worksheet.getAutoFilter();
@ -4159,7 +4157,6 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet {
* including: pivotCacheDefinition, pivotCacheRecords
* @return returns a pivotTable
*/
@SuppressWarnings("resource")
@Beta
private XSSFPivotTable createPivotTable() {
XSSFWorkbook wb = getWorkbook();

4
src/testcases/org/apache/poi/ss/usermodel/BaseTestCell.java
View File

@ -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 {