Update Javadoc somewhat

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1568555 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java b/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java
index ffb6e530bbf47c3643ee98e51e759cb714523693..2343226713b1f6ed5a0a63c351d4f1d89939d2d5 100644 (file)
--- 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 177cad89a93fa560a045b2b83df09b8c5e0b093a..390c20fa914b962ac35ae75f390594894ef44384 100644 (file)
--- 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 e67e78431068e32c7eab482dd0a4dab4fb83a17b..9b0885cc6ec86ecd107d6be8adc4dced223b6d86 100644 (file)
--- 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;