Commit 89f496fe by Jukka-Pekka Iivonen Committed by jpekka

### Documentation improvements.

```2001-11-16  Jukka-Pekka Iivonen  <jiivonen@hutcs.cs.hut.fi>

* fn-financial.c: Documentation improvements.```
parent 040a53ff
 ... ... @@ -2486,8 +2486,17 @@ static char *help_pmt = { N_("@FUNCTION=PMT\n" "@SYNTAX=PMT(rate,nper,pv[,fv,type])\n" "@DESCRIPTION=" "FIXME: Below is a PV function description!" "PMT calculates the present value of an investment." "PMT returns the amount of payment for a loan based on a constant " "interest rate and constant payments (each payment is equal amount). " "@rate is the constant interest rate. " "@nper is the overall number of payments. " "@pv is the present value. " "@fv is the future value. " "@type is the type of the payment: 0 means at the end of the period " "and 1 means at the beginning of the period. " "\n" "If @fv is omitted, Gnumeric assumes it to be zero. " "If @type is omitted, Gnumeric assumes it to be zero. " "\n" "@EXAMPLES=\n" "\n" ... ... @@ -2974,9 +2983,12 @@ static char *help_yielddisc = { N_("@FUNCTION=YIELDDISC\n" "@SYNTAX=YIELDDISC(settlement,maturity,pr,redemption[,basis])\n" "@DESCRIPTION=" "YIELDDISC FIXME. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "YIELDDISC calculates the annual yield of a security that is " "discounted. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@pr is the price per \$100 face value of the security. " "@redemption is the redemption value per \$100 face value. " "@basis is the type of day counting system you want to use:\n" "\n" "0 US 30/360\n" ... ... @@ -3007,9 +3019,13 @@ static char *help_yieldmat = { N_("@FUNCTION=YIELDMAT\n" "@SYNTAX=YIELDMAT(settlement,maturity,issue,rate,pr[,basis])\n" "@DESCRIPTION=" "YIELDMAT FIXME. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "YIELDMAT calculates the annual yield of a security for which " "the interest is payed at maturity date. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@issue is the issue date of the security. " "@rate is the interest rate set to the security. " "@pr is the price per \$100 face value of the security. " "@basis is the type of day counting system you want to use:\n" "\n" "0 US 30/360\n" ... ... @@ -3043,6 +3059,9 @@ static char *help_oddfprice = { "@DESCRIPTION=" "ODDFPRICE returns the price per \$100 face value of a security. " "The security should have an odd short or long first period. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@issue is the issue date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3126,7 +3145,10 @@ static char *help_oddfyield = { "@SYNTAX=ODDFYIELD(settlement,maturity,issue,first_coupon,rate," "pr,redemption,frequency[,basis])\n" "@DESCRIPTION=" "ODDFYIELD FIXME. " "ODDFYIELD calculates the yield of a security having an odd first " "period. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3160,7 +3182,24 @@ static char *help_oddlprice = { "@SYNTAX=ODDLPRICE(settlement,maturity,last_interest,rate,yld," "redemption,frequency[,basis])\n" "@DESCRIPTION=" "ODDLPRICE FIXME." "ODDLPRICE calculates the price per \$100 face value of a security " "that has an odd last coupon period. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" "\n" "0 US 30/360\n" "1 actual days/actual days\n" "2 actual days/360\n" "3 actual days/365\n" "4 European 30/360\n" "\n" "If @frequency is other than 1, 2, or 4, ODDFYIELD returns #NUM! " "error. " "If @basis is omitted, US 30/360 is applied. " "If @basis is not in between 0 and 4, #NUM! error is returned. " "\n" "@EXAMPLES=\n" "\n" ... ... @@ -3180,7 +3219,10 @@ static char *help_oddlyield = { "@SYNTAX=ODDLYIELD(settlement,maturity,last_interest,rate,pr," "redemption,frequency[,basis])\n" "@DESCRIPTION=" "ODDLYIELD FIXME." "ODDLYIELD calculates the yield of a security having an odd last " "period. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3215,8 +3257,8 @@ static char *help_amordegrc = { "rate[,basis])\n" "@DESCRIPTION=" "AMORDEGRC returns the depreciation for each accounting period." "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@basis is the type of day counting system you want to use:\n" "\n" "0 US 30/360\n" ... ... @@ -3249,8 +3291,8 @@ static char *help_amorlinc = { "rate[,basis])\n" "@DESCRIPTION=" "AMORLINC returns the depreciation for each accounting period." "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@basis is the type of day counting system you want to use:\n" "\n" "0 US 30/360\n" ... ... @@ -3283,6 +3325,8 @@ static char *help_coupdaybs = { "@DESCRIPTION=" "COUPDAYBS returns the number of days from the beginning of the " "coupon period to the settlement date. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3339,6 +3383,8 @@ static char *help_coupdays = { "@DESCRIPTION=" "COUPDAYS returns the number of days in the coupon period of the " "settlement date." "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3395,6 +3441,8 @@ static char *help_coupdaysnc = { "@DESCRIPTION=" "COUPDAYSNC returns the number of days from the settlement date " "to the next coupon date. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3450,6 +3498,8 @@ static char *help_coupncd = { "@SYNTAX=COUPNCD(settlement,maturity,frequency[,basis])\n" "@DESCRIPTION=" "COUPNCD returns the coupon date following settlement." "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3505,6 +3555,8 @@ static char *help_couppcd = { "@SYNTAX=COUPPCD(settlement,maturity,frequency[,basis])\n" "@DESCRIPTION=" "COUPPCD returns the coupon date preceeding settlement." "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3539,6 +3591,8 @@ static char *help_coupnum = { "@DESCRIPTION=" "COUPNUM returns the numbers of coupons to be paid between " "the settlement and maturity dates, rounded up." "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ...
 2001-11-16 Jukka-Pekka Iivonen * fn-financial.c: Documentation improvements. 2001-11-09 Jukka-Pekka Iivonen * fn-financial.c (coupdaysnc): Implemented the frequency 1 for ... ...
 ... ... @@ -2486,8 +2486,17 @@ static char *help_pmt = { N_("@FUNCTION=PMT\n" "@SYNTAX=PMT(rate,nper,pv[,fv,type])\n" "@DESCRIPTION=" "FIXME: Below is a PV function description!" "PMT calculates the present value of an investment." "PMT returns the amount of payment for a loan based on a constant " "interest rate and constant payments (each payment is equal amount). " "@rate is the constant interest rate. " "@nper is the overall number of payments. " "@pv is the present value. " "@fv is the future value. " "@type is the type of the payment: 0 means at the end of the period " "and 1 means at the beginning of the period. " "\n" "If @fv is omitted, Gnumeric assumes it to be zero. " "If @type is omitted, Gnumeric assumes it to be zero. " "\n" "@EXAMPLES=\n" "\n" ... ... @@ -2974,9 +2983,12 @@ static char *help_yielddisc = { N_("@FUNCTION=YIELDDISC\n" "@SYNTAX=YIELDDISC(settlement,maturity,pr,redemption[,basis])\n" "@DESCRIPTION=" "YIELDDISC FIXME. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "YIELDDISC calculates the annual yield of a security that is " "discounted. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@pr is the price per \$100 face value of the security. " "@redemption is the redemption value per \$100 face value. " "@basis is the type of day counting system you want to use:\n" "\n" "0 US 30/360\n" ... ... @@ -3007,9 +3019,13 @@ static char *help_yieldmat = { N_("@FUNCTION=YIELDMAT\n" "@SYNTAX=YIELDMAT(settlement,maturity,issue,rate,pr[,basis])\n" "@DESCRIPTION=" "YIELDMAT FIXME. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "YIELDMAT calculates the annual yield of a security for which " "the interest is payed at maturity date. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@issue is the issue date of the security. " "@rate is the interest rate set to the security. " "@pr is the price per \$100 face value of the security. " "@basis is the type of day counting system you want to use:\n" "\n" "0 US 30/360\n" ... ... @@ -3043,6 +3059,9 @@ static char *help_oddfprice = { "@DESCRIPTION=" "ODDFPRICE returns the price per \$100 face value of a security. " "The security should have an odd short or long first period. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@issue is the issue date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3126,7 +3145,10 @@ static char *help_oddfyield = { "@SYNTAX=ODDFYIELD(settlement,maturity,issue,first_coupon,rate," "pr,redemption,frequency[,basis])\n" "@DESCRIPTION=" "ODDFYIELD FIXME. " "ODDFYIELD calculates the yield of a security having an odd first " "period. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3160,7 +3182,24 @@ static char *help_oddlprice = { "@SYNTAX=ODDLPRICE(settlement,maturity,last_interest,rate,yld," "redemption,frequency[,basis])\n" "@DESCRIPTION=" "ODDLPRICE FIXME." "ODDLPRICE calculates the price per \$100 face value of a security " "that has an odd last coupon period. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" "\n" "0 US 30/360\n" "1 actual days/actual days\n" "2 actual days/360\n" "3 actual days/365\n" "4 European 30/360\n" "\n" "If @frequency is other than 1, 2, or 4, ODDFYIELD returns #NUM! " "error. " "If @basis is omitted, US 30/360 is applied. " "If @basis is not in between 0 and 4, #NUM! error is returned. " "\n" "@EXAMPLES=\n" "\n" ... ... @@ -3180,7 +3219,10 @@ static char *help_oddlyield = { "@SYNTAX=ODDLYIELD(settlement,maturity,last_interest,rate,pr," "redemption,frequency[,basis])\n" "@DESCRIPTION=" "ODDLYIELD FIXME." "ODDLYIELD calculates the yield of a security having an odd last " "period. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3215,8 +3257,8 @@ static char *help_amordegrc = { "rate[,basis])\n" "@DESCRIPTION=" "AMORDEGRC returns the depreciation for each accounting period." "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@basis is the type of day counting system you want to use:\n" "\n" "0 US 30/360\n" ... ... @@ -3249,8 +3291,8 @@ static char *help_amorlinc = { "rate[,basis])\n" "@DESCRIPTION=" "AMORLINC returns the depreciation for each accounting period." "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@basis is the type of day counting system you want to use:\n" "\n" "0 US 30/360\n" ... ... @@ -3283,6 +3325,8 @@ static char *help_coupdaybs = { "@DESCRIPTION=" "COUPDAYBS returns the number of days from the beginning of the " "coupon period to the settlement date. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3339,6 +3383,8 @@ static char *help_coupdays = { "@DESCRIPTION=" "COUPDAYS returns the number of days in the coupon period of the " "settlement date." "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3395,6 +3441,8 @@ static char *help_coupdaysnc = { "@DESCRIPTION=" "COUPDAYSNC returns the number of days from the settlement date " "to the next coupon date. " "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3450,6 +3498,8 @@ static char *help_coupncd = { "@SYNTAX=COUPNCD(settlement,maturity,frequency[,basis])\n" "@DESCRIPTION=" "COUPNCD returns the coupon date following settlement." "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3505,6 +3555,8 @@ static char *help_couppcd = { "@SYNTAX=COUPPCD(settlement,maturity,frequency[,basis])\n" "@DESCRIPTION=" "COUPPCD returns the coupon date preceeding settlement." "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ... @@ -3539,6 +3591,8 @@ static char *help_coupnum = { "@DESCRIPTION=" "COUPNUM returns the numbers of coupons to be paid between " "the settlement and maturity dates, rounded up." "@settlement is the settlement date of the security. " "@maturity is the maturity date of the security. " "@frequency is the number of coupon payments per year. " "Allowed frequencies are: 1 = annual, 2 = semi, 4 = quarterly. " "@basis is the type of day counting system you want to use:\n" ... ...
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!