Update javadoc on FinanceLib. This closes #162

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

diff --git a/src/java/org/apache/poi/ss/formula/functions/FinanceLib.java b/src/java/org/apache/poi/ss/formula/functions/FinanceLib.java
index f99047acec381ebabbd5d1e443caad2ca69398e0..19a7510c6823a9097feaa9c586d0688bb03b80ba 100644 (file)
--- a/src/java/org/apache/poi/ss/formula/functions/FinanceLib.java
+++ b/src/java/org/apache/poi/ss/formula/functions/FinanceLib.java
@@ -70,8 +70,8 @@ public final class FinanceLib {
      * @param r rate
      * @param n num of periods
      * @param y pmt per period
-     * @param p future value
-     * @param t type (true=pmt at end of period, false=pmt at begining of period)
+     * @param p present value
+     * @param t type (true=pmt at beginning of period, false=pmt at end of period)
      */
     public static double fv(double r, double n, double y, double p, boolean t) {
         double retval = 0;
@@ -92,11 +92,11 @@ public final class FinanceLib {
      * of individual payment, future value and boolean value indicating whether
      * payments are due at the beginning of period
      * (false => payments are due at end of period)
-     * @param r
-     * @param n
-     * @param y
-     * @param f
-     * @param t
+     * @param r rate
+     * @param n num of periods
+     * @param y pmt per period
+     * @param f future value
+     * @param t type (true=pmt at beginning of period, false=pmt at end of period)
      */
     public static double pv(double r, double n, double y, double f, boolean t) {
         double retval = 0;
@@ -118,7 +118,7 @@ public final class FinanceLib {
      * (supplied as an array). If the amounts are income the value should
      * be positive, else if they are payments and not income, the
      * value should be negative.
-     * @param r
+     * @param r rate
      * @param cfs cashflow amounts
      */
     public static double npv(double r, double[] cfs) {
@@ -134,11 +134,11 @@ public final class FinanceLib {
 
     /**
      *
-     * @param r
-     * @param n
-     * @param p
-     * @param f
-     * @param t
+     * @param r rate
+     * @param n num of periods
+     * @param p present value
+     * @param f future value
+     * @param t type (true=pmt at beginning of period, false=pmt at end of period)
      */
     public static double pmt(double r, double n, double p, double f, boolean t) {
         double retval = 0;
@@ -156,11 +156,11 @@ public final class FinanceLib {
 
     /**
      *
-     * @param r
-     * @param y
-     * @param p
-     * @param f
-     * @param t
+     * @param r rate
+     * @param y pmt per period
+     * @param p present value
+     * @param f future value
+     * @param t type (true=pmt at beginning of period, false=pmt at end of period)
      */
     public static double nper(double r, double y, double p, double f, boolean t) {
         double retval = 0;