From 9b4121cb451c488945f24a552373b236391821a7 Mon Sep 17 00:00:00 2001 From: Dominik Stadler Date: Sat, 15 Feb 2014 00:19:32 +0000 Subject: [PATCH] Update Javadoc somewhat git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1568555 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/poi/ss/util/CellRangeAddressBase.java | 10 +++++++++- .../apache/poi/xssf/usermodel/XSSFCreationHelper.java | 6 ++++++ .../org/apache/poi/xssf/usermodel/XSSFHyperlink.java | 2 +- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java b/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java index ffb6e530bb..2343226713 100644 --- a/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java +++ b/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java @@ -113,8 +113,16 @@ public abstract class CellRangeAddressBase { return _lastRow; } + /** + * Determines if the given coordinates lie within the bounds + * of this range. + * + * @param rowInd The row, 0-based. + * @param colInd The column, 0-based. + * @return True if the coordinates lie within the bounds, false otherwise. + */ public boolean isInRange(int rowInd, int colInd) { - return _firstRow <= rowInd && rowInd <= _lastRow && + return _firstRow <= rowInd && rowInd <= _lastRow && _firstCol <= colInd && colInd <= _lastCol; } diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCreationHelper.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCreationHelper.java index 177cad89a9..390c20fa91 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCreationHelper.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCreationHelper.java @@ -17,6 +17,7 @@ package org.apache.poi.xssf.usermodel; import org.apache.poi.ss.usermodel.CreationHelper; +import org.apache.poi.ss.usermodel.Hyperlink; public class XSSFCreationHelper implements CreationHelper { private XSSFWorkbook workbook; @@ -38,6 +39,11 @@ public class XSSFCreationHelper implements CreationHelper { return workbook.createDataFormat(); } + /** + * Create a new XSSFHyperlink. + * + * @param type - the type of hyperlink to create, see {@link Hyperlink} + */ public XSSFHyperlink createHyperlink(int type) { return new XSSFHyperlink(type); } diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java index e67e784310..9b0885cc6e 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java @@ -40,7 +40,7 @@ public class XSSFHyperlink implements Hyperlink { /** * Create a new XSSFHyperlink. This method is protected to be used only by XSSFCreationHelper * - * @param type - the type of hyperlink to create + * @param type - the type of hyperlink to create, see {@link Hyperlink} */ protected XSSFHyperlink(int type) { _type = type; -- 2.39.5