JavaDoc fixes from #54731 from Dominik Stadler

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

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 1b356fb3e57a8fb938a7083b1b65cbbd7cf37356..1ad0488ce7434ee856e456db3ff1e6165ca1c6ef 100644 (file)
--- 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 4058419125a448eee36ed0135326c0f79b2c35ac..ab7a4009e56d81f00c1782e7f3417e2a414306ab 100644 (file)
--- 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 2082634d18160ec843c6e50f17138512f301db6a..5d747c59caa9351dc67f38232a256a0425e2e897 100644 (file)
--- 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 f7c37e30052f072d32f2d19793b1938b517be937..10b41055514f7f400981a8ff608f4b0ea5f0e8fe 100644 (file)
--- 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 26c17c54049c034e20247f90bc4f1abdf6861a8b..5765b6dd3ce389d91bff030dae8bee62c552761e 100644 (file)
--- 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) {