aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache
diff options
context:
space:
mode:
authorNick Burch <nick@apache.org>2013-06-12 16:32:24 +0000
committerNick Burch <nick@apache.org>2013-06-12 16:32:24 +0000
commit38691d40ab8643240eaa6f9355bb0620c0eb3677 (patch)
treec0f6215544a0e27485019ee826297b2aca0e1331 /src/java/org/apache
parent6e7b5eec64c704773926df70a00dbb13db991355 (diff)
downloadpoi-38691d40ab8643240eaa6f9355bb0620c0eb3677.tar.gz
poi-38691d40ab8643240eaa6f9355bb0620c0eb3677.zip
JavaDoc fixes from #54731 from Dominik Stadler
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1492267 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/java/org/apache')
-rw-r--r--src/java/org/apache/poi/hssf/record/aggregates/ColumnInfoRecordsAggregate.java2
-rw-r--r--src/java/org/apache/poi/ss/formula/functions/Finance.java2
-rw-r--r--src/java/org/apache/poi/ss/util/AreaReference.java2
-rw-r--r--src/java/org/apache/poi/ss/util/CellReference.java2
4 files changed, 6 insertions, 2 deletions
diff --git a/src/java/org/apache/poi/hssf/record/aggregates/ColumnInfoRecordsAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/ColumnInfoRecordsAggregate.java
index 1b356fb3e5..1ad0488ce7 100644
--- a/src/java/org/apache/poi/hssf/record/aggregates/ColumnInfoRecordsAggregate.java
+++ b/src/java/org/apache/poi/hssf/record/aggregates/ColumnInfoRecordsAggregate.java
@@ -171,7 +171,7 @@ public final class ColumnInfoRecordsAggregate extends RecordAggregate {
/**
* 'Collapsed' state is stored in a single column col info record immediately after the outline group
* @param idx
- * @return
+ * @return true, if the column is collapsed, false otherwise.
*/
private boolean isColumnGroupCollapsed(int idx) {
int endOfOutlineGroupIdx = findEndOfColumnOutlineGroup(idx);
diff --git a/src/java/org/apache/poi/ss/formula/functions/Finance.java b/src/java/org/apache/poi/ss/formula/functions/Finance.java
index 4058419125..ab7a4009e5 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Finance.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Finance.java
@@ -107,7 +107,7 @@ public class Finance {
* @return <code>double</code> representing principal portion of payment.
*
* @see #pmt(double, int, double, double, int)
- * @see #ipmt(double, int, int, double, double, boolean)
+ * @see #ipmt(double, int, int, double, double, int)
*/
static public double ppmt(double r, int per, int nper, double pv, double fv, int type) {
return pmt(r, nper, pv, fv, type) - ipmt(r, per, nper, pv, fv, type);
diff --git a/src/java/org/apache/poi/ss/util/AreaReference.java b/src/java/org/apache/poi/ss/util/AreaReference.java
index 2082634d18..5d747c59ca 100644
--- a/src/java/org/apache/poi/ss/util/AreaReference.java
+++ b/src/java/org/apache/poi/ss/util/AreaReference.java
@@ -261,6 +261,8 @@ public class AreaReference {
}
/**
+ * Returns a text representation of this area reference.
+ * <p/>
* Example return values:
* <table border="0" cellpadding="1" cellspacing="0" summary="Example return values">
* <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
diff --git a/src/java/org/apache/poi/ss/util/CellReference.java b/src/java/org/apache/poi/ss/util/CellReference.java
index f7c37e3005..10b4105551 100644
--- a/src/java/org/apache/poi/ss/util/CellReference.java
+++ b/src/java/org/apache/poi/ss/util/CellReference.java
@@ -437,6 +437,8 @@ public class CellReference {
}
/**
+ * Returns a text representation of this cell reference.
+ * <p/>
* Example return values:
* <table border="0" cellpadding="1" cellspacing="0" summary="Example return values">
* <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>