From 38691d40ab8643240eaa6f9355bb0620c0eb3677 Mon Sep 17 00:00:00 2001
From: Nick Burch <nick@apache.org>
Date: Wed, 12 Jun 2013 16:32:24 +0000
Subject: [PATCH] JavaDoc fixes from #54731 from Dominik Stadler

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1492267 13f79535-47bb-0310-9956-ffa450edef68
---
 .../poi/hssf/record/aggregates/ColumnInfoRecordsAggregate.java  | 2 +-
 src/java/org/apache/poi/ss/formula/functions/Finance.java       | 2 +-
 src/java/org/apache/poi/ss/util/AreaReference.java              | 2 ++
 src/java/org/apache/poi/ss/util/CellReference.java              | 2 ++
 src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java     | 2 +-
 5 files changed, 7 insertions(+), 3 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>
diff --git a/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java b/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
index 26c17c5404..5765b6dd3c 100644
--- a/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
+++ b/src/ooxml/java/org/apache/poi/openxml4j/opc/OPCPackage.java
@@ -755,7 +755,7 @@ public abstract class OPCPackage implements RelationshipSource, Closeable {
 	 *             If rule M1.12 is not verified : Packages shall not contain
 	 *             equivalent part names and package implementers shall neither
 	 *             create nor recognize packages with equivalent part names.
-	 * @see {@link#createPartImpl(URI, String)}
+	 * @see #createPartImpl(PackagePartName, String, boolean)
 	 */
 	PackagePart createPart(PackagePartName partName, String contentType,
 			boolean loadRelationships) {
-- 
2.39.5