Mercurial > octave-nkf
changeset 3407:5e0a0b1cba43
[project @ 2000-01-06 03:13:55 by jwe]
line wrap: on
line diff
--- a/scripts/ChangeLog Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/ChangeLog Thu Jan 06 03:14:17 2000 +0000 @@ -1,3 +1,99 @@ +2000-01-05 Ben Sapp <bsapp@nua.lampf.lanl.gov> + + * io/printf.m: Add @seealso{...} to doc string. + * io/puts.m: Likewise. + * plot/semilogx.m: Likewise. + * plot/semilogy.m: Likewise. + * plot/__pltopt__.m: Likewise. + * plot/bar.m: Likewise. + * plot/xlabel.m: Likewise. + * plot/grid.m: Likewise. + * plot/shg.m: Likewise. + * plot/title.m: Likewise. + * plot/mesh.m: Likewise. + * plot/__pltopt1__.m: Likewise. + * plot/contour.m: Likewise. + * plot/hist.m: Likewise. + * plot/stairs.m: Likewise. + * plot/meshgrid.m: Likewise. + * plot/polar.m: Likewise. + * plot/loglog.m: Likewise. + * plot/plot.m: Likewise. + * miscellaneous/semicolon.m: Likewise. + * miscellaneous/menu.m: Likewise. + * miscellaneous/etime.m: Likewise. + * miscellaneous/texas_lotto.m: Likewise. + * miscellaneous/comma.m: Likewise. + * audio/lin2mu.m: Likewise. + * audio/playaudio.m: Likewise. + * audio/loadaudio.m: Likewise. + * audio/saveaudio.m: Likewise. + * audio/mu2lin.m: Likewise. + * audio/record.m: Likewise. + * strings/isletter.m: Likewise. + * strings/lower.m: Likewise. + * strings/lower.m: Likewise. + * strings/upper.m: Likewise. + * specfun/erfinv.m: Likewise. + * specfun/gammai.m: Likewise. + * specfun/log2.m: Likewise. + * specfun/pow2.m: Likewise. + * elfun/gcd.m: Likewise. + * elfun/lcm.m: Likewise. + * special-matrix/vander.m: Likewise. + * special-matrix/sylvester_matrix.m: Likewise. + * special-matrix/hilb.m: Likewise. + * special-matrix/hankel.m: Likewise. + * special-matrix/toeplitz.m: Likewise. + * special-matrix/invhilb.m: Likewise. + * statistics/base/std.m: Likewise. + * statistics/base/median.m: Likewise. + * linear-algebra/cond.m: Likewise. + * linear-algebra/norm.m: Likewise. + * finance/nper.m: Likewise. + * finance/pmt.m: Likewise. + * finance/pv.m: Likewise. + * finance/rate.m: Likewise. + * finance/npv.m: Likewise. + * general/fliplr.m: Likewise. + * general/flipud.m: Likewise. + * general/is_scalar.m: Likewise. + * general/rem.m: Likewise. + * general/perror.m: Likewise. + * general/tril.m: Likewise. + * general/rot90.m: Likewise. + * general/num2str.m: Likewise. + * general/int2str.m: Likewise. + * general/reshape.m: Likewise. + * general/logspace.m: Likewise. + * general/is_symmetric.m: Likewise. + * general/is_vector.m: Likewise. + * general/nextpow2.m: Likewise. + * general/columns.m: Likewise. + * general/is_square.m: Likewise. + * general/rows.m: Likewise. + * control/ugain.m: Likewise. + * control/damp.m: Likewise. + * control/dare.m: Likewise. + * control/are.m: Likewise. + * control/sys2fir.m: Likewise. + * control/abcddim.m: Likewise. + * control/is_abcd.m: Likewise. + * control/step.m: Likewise. + * control/is_observable.m: Likewise. + * control/is_controllable.m: Likewise. + * control/jet707.m: Likewise. + * control/polyout.m: Likewise. + * control/impulse.m: Likewise. + * control/lqg.m: Likewise. + * control/is_detectable.m: Likewise. + * control/sysdimensions.m: Likewise. + * control/sysupdate.m: Likewise. + * control/stepimp.m: Likewise. + * control/is_stable.m: Likewise. + * control/tfout.m: Likewise. + * control/zpout.m: Likewise. + 2000-01-05 John W. Eaton <jwe@bevo.che.wisc.edu> * set/complement.m: Add @seealso{} stuff.
--- a/scripts/audio/lin2mu.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/audio/lin2mu.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,8 +23,7 @@ ## linear encoding, @code{lin2mu (@var{x})} is the corresponding mu-law ## encoding. ## @end deftypefn - -## See also: mu2lin, loadaudio, saveaudio, playaudio, setaudio, record +## @seealso{mu2lin, loadaudio, saveaudio, playaudio, setaudio, record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 17 October 1994
--- a/scripts/audio/loadaudio.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/audio/loadaudio.m Thu Jan 06 03:14:17 2000 +0000 @@ -30,8 +30,7 @@ ## The argument @var{bps} can be either 8 (default) or 16, and specifies ## the number of bits per sample used in the audio file. ## @end deftypefn - -## See also: lin2mu, mu2lin, saveaudio, playaudio, setaudio, record +## @seealso{lin2mu, mu2lin, saveaudio, playaudio, setaudio, record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 10 April 1994
--- a/scripts/audio/mu2lin.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/audio/mu2lin.m Thu Jan 06 03:14:17 2000 +0000 @@ -24,8 +24,7 @@ ## @var{bps} specifies whether the input data uses 8 bit per sample ## (default) or 16 bit. ## @end deftypefn - -## See also: lin2mu, loadaudio, saveaudio, playaudio, setaudio, record +## @seealso{lin2mu, loadaudio, saveaudio, playaudio, setaudio, record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 18 October 1994
--- a/scripts/audio/playaudio.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/audio/playaudio.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,8 +23,7 @@ ## Plays the audio file @file{@var{name}.@var{ext}} or the audio data ## stored in the vector @var{x}. ## @end deftypefn - -## See also: lin2mu, mu2lin, loadaudio, saveaudio, setaudio, record +## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, setaudio, record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 11 April 1994
--- a/scripts/audio/record.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/audio/record.m Thu Jan 06 03:14:17 2000 +0000 @@ -24,8 +24,7 @@ ## 8kHz. The program waits until the user types @key{RET} and then ## immediately starts to record. ## @end deftypefn - -## See also: lin2mu, mu2lin, loadaudio, saveaudio, playaudio, setaudio +## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, playaudio, setaudio} ## usage: X = record (sec [, sampling_rate]) ##
--- a/scripts/audio/saveaudio.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/audio/saveaudio.m Thu Jan 06 03:14:17 2000 +0000 @@ -25,8 +25,7 @@ ## in the audio file (see @code{loadaudio}); defaults are @file{lin} and ## 8, respectively. ## @end deftypefn - -## See also: lin2mu, mu2lin, loadaudio, playaudio, setaudio, record +## @seealso{lin2mu, mu2lin, loadaudio, playaudio, setaudio, record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 5 September 1994
--- a/scripts/control/abcddim.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/abcddim.m Thu Jan 06 03:14:17 2000 +0000 @@ -58,8 +58,8 @@ ## ## Note: n = 0 (pure gain block) is returned without warning. ## -## See also: is_abcd ## @end deftypefn +## @seealso{is_abcd} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993.
--- a/scripts/control/are.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/are.m Thu Jan 06 03:14:17 2000 +0000 @@ -58,8 +58,7 @@ ## matrix. ## ## @end deftypefn - -## See also: balance, dare +## @seealso{balance, dare} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/damp.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/damp.m Thu Jan 06 03:14:17 2000 +0000 @@ -25,8 +25,8 @@ ## If @var{p} is a matrix and @var{tsam} is specified, eigenvalues ## of @var{p} are assumed to be in @var{z}-domain. ## -## See also: @code{eig} ## @end deftypefn +## @seealso{eig} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: September 29, 1997.
--- a/scripts/control/dare.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/dare.m Thu Jan 06 03:14:17 2000 +0000 @@ -68,8 +68,7 @@ ## Systems, Vol 5, no 2 (1992) pp 165-194. ## ## @end deftypefn - -## See also: balance, are +## @seealso{balance, are} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/impulse.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/impulse.m Thu Jan 06 03:14:17 2000 +0000 @@ -41,8 +41,7 @@ ## @strong{Outputs} ## @var{y}, @var{t}: impulse response ## @end deftypefn - -## See also: step, stepimp +## @seealso{step, stepimp} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: October 2, 1997
--- a/scripts/control/is_abcd.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/is_abcd.m Thu Jan 06 03:14:17 2000 +0000 @@ -22,8 +22,7 @@ ## are compatible, otherwise @var{retval} = 0 with an appropriate diagnostic ## message printed to the screen. The matrices b, c, or d may be omitted. ## @end deftypefn - -## See also: abcddim +## @seealso{abcddim} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: November 4, 1997
--- a/scripts/control/is_controllable.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/is_controllable.m Thu Jan 06 03:14:17 2000 +0000 @@ -50,14 +50,9 @@ ## @end example ## The Arnoldi iteration is executed with @code{krylov} if the system has a single input; otherwise a block Arnoldi iteration is performed with @code{krylovb}. ## -## @strong{See also} -## @code{is_observable}, @code{is_stabilizable}, @code{is_detectable}, -## @code{krylov}, @code{krylovb} -## ## @end deftypefn - -## See also: size, rows, columns, length, is_matrix, is_scalar, is_vector -## is_observable, is_stabilizable, is_detectable, krylov, krylovb +## @seealso{size, rows, columns, length, is_matrix, is_scalar, is_vector +## is_observable, is_stabilizable, is_detectable, krylov, krylovb} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/is_detectable.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/is_detectable.m Thu Jan 06 03:14:17 2000 +0000 @@ -30,8 +30,7 @@ ## Default: tol = 10*norm(a,'fro')*eps ## ## @end deftypefn - -## See also: size, rows, columns, length, is_matrix, is_scalar, is_vector. +## @seealso{is_stabilizable, size, rows, columns, length, is_matrix, is_scalar, is_vector} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/is_observable.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/is_observable.m Thu Jan 06 03:14:17 2000 +0000 @@ -29,8 +29,7 @@ ## @strong{See} @code{is_controllable} for detailed description of arguments ## and default values. ## @end deftypefn - -## See also: size, rows, columns, length, is_matrix, is_scalar, is_vector. +## @seealso{size, rows, columns, length, is_matrix, is_scalar, is_vector} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/is_stable.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/is_stable.m Thu Jan 06 03:14:17 2000 +0000 @@ -37,9 +37,8 @@ ## @end table ## @end table ## @end deftypefn - -## See also: size, rows, columns, length, is_matrix, is_scalar, is_vector -## is_observable, is_stabilizable, is_detectable, krylov, krylovb +## @seealso{size, rows, columns, length, is_matrix, is_scalar, is_vector +## is_observable, is_stabilizable, is_detectable, krylov, krylovb} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/jet707.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/jet707.m Thu Jan 06 03:14:17 2000 +0000 @@ -24,8 +24,7 @@ ## System outputs: (1) airspeed and (2) pitch angle ## Ref: R. Brockhaus: Flugregelung (Flight Control), Springer, 1994 ## @end deftypefn - -## see also: ord2 +## @seealso{ord2} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: September 28, 1997
--- a/scripts/control/lqg.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/lqg.m Thu Jan 06 03:14:17 2000 +0000 @@ -58,8 +58,7 @@ ## controller poles ## @end table ## @end deftypefn - -## See also: h2syn, lqe, lqr +## @seealso{h2syn, lqe, lqr} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1995
--- a/scripts/control/polyout.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/polyout.m Thu Jan 06 03:14:17 2000 +0000 @@ -25,9 +25,8 @@ ## to string @var{y} or to the screen (if @var{y} is omitted) ## @var{x} defaults to the string @code{"s"} ## @end deftypefn - -## See also: polyval, polyvalm, poly, roots, conv, deconv, residue, -## filter, polyderiv, polyinteg +## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, +## filter, polyderiv, polyinteg} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: May 1995
--- a/scripts/control/step.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/step.m Thu Jan 06 03:14:17 2000 +0000 @@ -43,8 +43,7 @@ ## ## When invoked with the output paramter y the plot is not displayed. ## @end deftypefn - -## See also: impulse, stepimp +## @seealso{impulse, stepimp} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: September 30, 1997
--- a/scripts/control/stepimp.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/stepimp.m Thu Jan 06 03:14:17 2000 +0000 @@ -29,8 +29,7 @@ ## or @code{impulse} instead. ## ## @end deftypefn - -## See also: step, impulse +## @seealso{step, impulse} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: October 2, 1997
--- a/scripts/control/sys2fir.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/sys2fir.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,8 +23,7 @@ ## parameter descriptions. ## ## @end deftypefn - -## See also: fir2sys +## @seealso{fir2sys} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: July 1996
--- a/scripts/control/sysdimensions.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/sysdimensions.m Thu Jan 06 03:14:17 2000 +0000 @@ -63,8 +63,7 @@ ## @end table ## ## @end deftypefn - -## See also: sysgetsignals, sysgettsam +## @seealso{sysgetsignals, sysgettsam} function [n, nz, m, p, yd] = sysdimensions (sys, opt)
--- a/scripts/control/sysupdate.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/sysupdate.m Thu Jan 06 03:14:17 2000 +0000 @@ -45,8 +45,7 @@ ## Conversion to @code{tf} or @code{zp} exits with an error if the system is ## mixed continuous/digital. ## @end deftypefn - -## See also: tf2sys, ss2sys, zp2sys, sysout, sys2ss, sys2tf, sys2zp +## seealso{tf2sys, ss2sys, zp2sys, sysout, sys2ss, sys2tf, sys2zp} ## Author: John Ingram <ingraje@eng.auburn.edu> ## Created: July 9, 1996
--- a/scripts/control/tfout.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/tfout.m Thu Jan 06 03:14:17 2000 +0000 @@ -21,9 +21,8 @@ ## print formatted transfer function @math{n(s)/d(s) } to the screen ## @var{x} defaults to the string @code{"s"} ## @end deftypefn - -## See also: polyval, polyvalm, poly, roots, conv, deconv, residue, -## filter, polyderiv, polyinteg, polyout +## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, +## filter, polyderiv, polyinteg, polyout} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: June 1995
--- a/scripts/control/ugain.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/ugain.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,10 +23,8 @@ ## complex systems from simple systems with buildssic. ## Watch out if you are forming sampled systems since "ugain" ## does not contain a sampling period. -## -## See also: hinfdemo (MIMO H_infinty example, Boeing 707-321 aircraft model) -## ## @end deftypefn +## @seealso{hinfdemo (MIMO H_infinty example, Boeing 707-321 aircraft model)} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: April 1998
--- a/scripts/control/zpout.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/control/zpout.m Thu Jan 06 03:14:17 2000 +0000 @@ -21,9 +21,8 @@ ## print formatted zero-pole form to the screen. ## @var{x} defaults to the string @code{"s"} ## @end deftypefn - -## See also: polyval, polyvalm, poly, roots, conv, deconv, residue, -## filter, polyderiv, polyinteg, polyout +## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, +## filter, polyderiv, polyinteg, polyout} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: June 1995
--- a/scripts/elfun/gcd.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/elfun/gcd.m Thu Jan 06 03:14:17 2000 +0000 @@ -40,8 +40,7 @@ ## g = v(1) * a(k) + ... + v(k) * a(k) ## @end example ## @end deftypefn - -## See also: lcm, min, max, ceil, floor. +## @seealso{lcm, min, max, ceil, floor} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Created: 16 September 1994
--- a/scripts/elfun/lcm.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/elfun/lcm.m Thu Jan 06 03:14:17 2000 +0000 @@ -33,8 +33,7 @@ ## lcm ([a1, ..., ak]). ## @end example ## @end deftypefn - -## See also: gcd, min, max, ceil, floor. +## @seealso{gcd, min, max, ceil, floor} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Created: 16 September 1994
--- a/scripts/finance/nper.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/finance/nper.m Thu Jan 06 03:14:17 2000 +0000 @@ -14,21 +14,22 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: nper (r, p, a [, l] [, method]) +## -*- texinfo -*- +## @deftypefn {Function File} {} nper (@var{r}, @var{p}, @var{a} [, @var{l}] [, @var{method}]) ## -## Computes the number of regular payments of p necessary to amortize a -## loan of amount a and interest r. +## Computes the number of regular payments of @var{p} necessary to amortize @var{a} +## loan of amount @var{a} and interest @var{r}. ## -## With the optional scalar argument l, one can specify an additional -## lump-sum payment of l made at the end of the amortization time. With +## With the optional scalar argument @var{l}, one can specify an additional +## lump-sum payment of @var{l} made at the end of the amortization time. With ## the optional string argument `method', one can specify whether ## payments are made at the end ("e", default) or at the beginning ("b") ## of each period. ## ## Note that the rate r is not specified in percent, i.e., one has to ## write 0.05 rather than 5 %. -## -## See also: pv, pmt, rate; npv. +## @end deftypefn +## @seealso{pv, pmt, rate, npv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Number of payments needed for amortizing a loan
--- a/scripts/finance/npv.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/finance/npv.m Thu Jan 06 03:14:17 2000 +0000 @@ -14,21 +14,21 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: npv (r, p [, i]) -## +## -*- texinfo -*- +## @deftypefn {Function File} {} npv (@var{r}, @var{p} [, @var{i}]) ## Returns the net present value of a series of irregular (i.e., not -## necessarily identical) payments p which occur at the ends of n -## consecutive periods. r specifies the one-period interest rates and +## necessarily identical) payments @var{p} which occur at the ends of @var{n} +## consecutive periods. @var{r} specifies the one-period interest rates and ## can either be a scalar (constant rates) or a vector of the same -## length as p. +## length as @var{p}. ## -## With the optional scalar argument i, one can specify an initial +## With the optional scalar argument @var{i}, one can specify an initial ## investment. ## ## Note that rates are not specified in percent, i.e., one has to write ## 0.05 rather than 5 %. -## -## See also: irr; pv. +## @end deftypefn +## @seealso{irr, pv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Net present value of a series of payments @@ -68,4 +68,4 @@ p = [i, p]; v = sum (d .* p); -endfunction \ No newline at end of file +endfunction
--- a/scripts/finance/pmt.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/finance/pmt.m Thu Jan 06 03:14:17 2000 +0000 @@ -14,17 +14,17 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: pmt (r, n, a [, l] [, method]) -## +## -*- texinfo -*- +## @deftypefn {Function File} {} pmt (@var{r}, @var{n}, @var{a} [, @var{l}] [, @var{method}]) ## Compute the amount of periodic payment necessary to amortize a loan -## of amount a with interest rate r in n periods. +## of amount a with interest rate @var{r} in @var{n} periods. ## ## With the optional scalar argument l, one can specify an initial ## lump-sum payment. With the optional string argument `method', one can ## specify whether payments are made at the end ("e", default) or at the ## beginning ("b") of each period. -## -## See also: pv, nper, rate +## @end deftypefn +## @seealso{pv, nper, rate} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Amount of periodic payment needed to amortize a loan
--- a/scripts/finance/pv.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/finance/pv.m Thu Jan 06 03:14:17 2000 +0000 @@ -14,13 +14,13 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: pv (r, n, p [, l] [, method]) +## -*- texinfo -*- +## @deftypefn {Function File} {} pv (@var{r}, @var{n}, @var{p} [, @var{l}] [, @var{method}]) +## Returns the present value of an investment that will pay off @var{p} for @var{n} +## consecutive periods, assuming an interest @var{r}. ## -## Returns the present value of an investment that will pay off p for n -## consecutive periods, assuming an interest r. -## -## With the optional scalar argument l, one can specify an additional -## lump-sum payment made at the end of n periods. +## With the optional scalar argument @var{l}, one can specify an additional +## lump-sum payment made at the end of @var{n} periods. ## ## With the optional string argument `method', one can specify whether ## payments are made at the end ("e", default) or at the beginning ("b") @@ -28,8 +28,8 @@ ## ## Note that the rate r is not specified in percent, i.e., one has to ## write 0.05 rather than 5 %. -## -## See also: pmt, nper, rate; npv. +## @end deftypefn +## @seealso{pmt, nper, rate, npv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Present value of an investment
--- a/scripts/finance/rate.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/finance/rate.m Thu Jan 06 03:14:17 2000 +0000 @@ -14,17 +14,17 @@ ## along with this file. If not, write to the Free Software Foundation, ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -## usage: rate (n, p, v [, l] [, method]) -## -## Computes the rate of return on an investment of present value v which -## pays p in n consecutive periods. +## -*- texinfo -*- +## @deftypefn {Function File} {} rate (@var{n}, @var{p}, @var{v} [, @var{l}] [,@var{method}]) +## Computes the rate of return on an investment of present value @var{v} which +## pays @var{p} in @var{n} consecutive periods. ## -## With the optional scalar argument l, one can specify an additional -## lump-sum payment made at the end of n periods. With the optional -## string argument `method', one can specify whether payments are made +## With the optional scalar argument @var{l}, one can specify an additional +## lump-sum payment made at the end of @var{n} periods. With the optional +## string argument @var{`method'}, one can specify whether payments are made ## at the end ("e", default) or at the beginning ("b") of each period. -## -## See also: pv, pmt, nper; npv. +## @end deftypefn +## @seealso{pv, pmt, nper, npv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Rate of return of an investment @@ -69,4 +69,4 @@ [r, info] = fsolve ("f", 0); -endfunction \ No newline at end of file +endfunction
--- a/scripts/general/columns.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/columns.m Thu Jan 06 03:14:17 2000 +0000 @@ -21,8 +21,7 @@ ## @deftypefn {Function File} {} columns (@var{a}) ## Return the number of columns of @var{a}. ## @end deftypefn - -## See also: size, rows, length, is_scalar, is_vector, is_matrix +## @seealso{size, rows, length, is_scalar, is_vector, is_matrix} ## Author: jwe
--- a/scripts/general/fliplr.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/fliplr.m Thu Jan 06 03:14:17 2000 +0000 @@ -30,8 +30,7 @@ ## @end group ## @end example ## @end deftypefn - -## See also: flipu, rot90 +## @seealso{flipud, rot90} ## Author: jwe
--- a/scripts/general/flipud.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/flipud.m Thu Jan 06 03:14:17 2000 +0000 @@ -30,8 +30,7 @@ ## @end group ## @end example ## @end deftypefn - -## See also: fliplr, rot90 +## @seealso{fliplr, rot90} ## Author: jwe
--- a/scripts/general/int2str.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/int2str.m Thu Jan 06 03:14:17 2000 +0000 @@ -24,8 +24,7 @@ ## but are provided for compatibility with @sc{Matlab}. For better control ## over the results, use @code{sprintf} (@pxref{Formatted Output}). ## @end deftypefn - -## See also: sprintf, num2str +## @seealso{sprintf, num2str} ## Author: jwe
--- a/scripts/general/is_scalar.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/is_scalar.m Thu Jan 06 03:14:17 2000 +0000 @@ -21,8 +21,7 @@ ## @deftypefn {Function File} {} is_scalar (@var{a}) ## Return 1 if @var{a} is a scalar. Otherwise, return 0. ## @end deftypefn - -## See also: size, rows, columns, length, is_scalar, is_matrix +## @seealso{size, rows, columns, length, is_scalar, is_matrix} ## Author: jwe
--- a/scripts/general/is_square.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/is_square.m Thu Jan 06 03:14:17 2000 +0000 @@ -22,8 +22,7 @@ ## If @var{x} is a square matrix, then return the dimension of @var{x}. ## Otherwise, return 0. ## @end deftypefn - -## See also: size, rows, columns, length, is_matrix, is_scalar, is_vector +## @seealso{size, rows, columns, length, is_matrix, is_scalar, is_vector} ## Author: A. S. Hodel <scotte@eng.auburn.edu> ## Created: August 1993
--- a/scripts/general/is_symmetric.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/is_symmetric.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,9 +23,8 @@ ## then return the dimension of @var{x}. Otherwise, return 0. If ## @var{tol} is omitted, use a tolerance equal to the machine precision. ## @end deftypefn - -## See also: size, rows, columns, length, is_matrix, is_scalar, -## is_square, is_vector +## @seealso{size, rows, columns, length, is_matrix, is_scalar, +## is_square, is_vector} ## Author: A. S. Hodel <scotte@eng.auburn.edu> ## Created: August 1993
--- a/scripts/general/is_vector.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/is_vector.m Thu Jan 06 03:14:17 2000 +0000 @@ -21,8 +21,7 @@ ## @deftypefn {Function File} {} is_vector (@var{a}) ## Return 1 if @var{a} is a vector. Otherwise, return 0. ## @end deftypefn - -## See also: size, rows, columns, length, is_scalar, is_matrix +## @seealso{size, rows, columns, length, is_scalar, is_matrix} ## Author: jwe
--- a/scripts/general/logspace.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/logspace.m Thu Jan 06 03:14:17 2000 +0000 @@ -59,8 +59,7 @@ ## @end ifinfo ## in order to be compatible with the corresponding @sc{Matlab} function. ## @end deftypefn - -## See also: linspace +## @seealso{linspace} ## Author: jwe
--- a/scripts/general/nextpow2.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/nextpow2.m Thu Jan 06 03:14:17 2000 +0000 @@ -28,8 +28,7 @@ ## ## If @var{x} is a vector, return @code{nextpow2 (length (@var{x}))}. ## @end deftypefn - -## See also: pow2 +## @seealso{pow2} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Created: 7 October 1994
--- a/scripts/general/num2str.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/num2str.m Thu Jan 06 03:14:17 2000 +0000 @@ -24,8 +24,7 @@ ## but are provided for compatibility with @sc{Matlab}. For better control ## over the results, use @code{sprintf} (@pxref{Formatted Output}). ## @end deftypefn - -## See also: sprintf, int2str +## @seealso{sprintf, int2str} ## Author: jwe
--- a/scripts/general/perror.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/perror.m Thu Jan 06 03:14:17 2000 +0000 @@ -24,8 +24,7 @@ ## useful error messages for those functions that return numeric error ## codes. ## @end deftypefn - -## See also: strerror +## @seealso{strerror} ## Author: jwe
--- a/scripts/general/rem.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/rem.m Thu Jan 06 03:14:17 2000 +0000 @@ -29,8 +29,7 @@ ## An error message is printed if the dimensions of the arguments do not ## agree, or if either of the arguments is complex. ## @end deftypefn - -## See also: round +## @seealso{round} ## Author: jwe
--- a/scripts/general/reshape.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/reshape.m Thu Jan 06 03:14:17 2000 +0000 @@ -49,8 +49,7 @@ ## colon operator. Note that the total number of elements in the original ## matrix must match the total number of elements in the new matrix. ## @end deftypefn - -## See also: `:', do_fortran_indexing +## @seealso{`:', do_fortran_indexing} ## Author: jwe
--- a/scripts/general/rot90.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/rot90.m Thu Jan 06 03:14:17 2000 +0000 @@ -47,8 +47,7 @@ ## @end group ## @end example ## @end deftypefn - -## See also: flipud, fliplr +## @seealso{flipud, fliplr} ## Author: jwe
--- a/scripts/general/rows.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/rows.m Thu Jan 06 03:14:17 2000 +0000 @@ -21,8 +21,7 @@ ## @deftypefn {Function File} {} rows (@var{a}) ## Return the number of rows of @var{a}. ## @end deftypefn - -## See also: size, columns, length, is_scalar, is_vector, is_matrix +## @seealso{size, columns, length, is_scalar, is_vector, is_matrix} ## Author: jwe
--- a/scripts/general/tril.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/general/tril.m Thu Jan 06 03:14:17 2000 +0000 @@ -60,8 +60,7 @@ ## @end group ## @end example ## @end deftypefn - -## See also: triu, diag +## @seealso{triu, diag} ## Author: jwe
--- a/scripts/io/printf.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/io/printf.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,8 +23,7 @@ ## control of the template string @var{template} to the stream ## @code{stdout}. ## @end deftypefn - -## See also: fprintf sprintf +## @seealso{fprintf and sprintf} ## Author: jwe
--- a/scripts/linear-algebra/cond.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/linear-algebra/cond.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,8 +23,7 @@ ## defined as @code{norm (a) * norm (inv (a))}, and is computed via a ## singular value decomposition. ## @end deftypefn - -## See also: norm, svd, rank +## @seealso{norm, svd, rank} ## Author: jwe
--- a/scripts/linear-algebra/norm.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/linear-algebra/norm.m Thu Jan 06 03:14:17 2000 +0000 @@ -53,8 +53,7 @@ ## p-norm of @var{a}, @code{(sum (abs (@var{a}) .^ @var{p})) ^ (1/@var{p})}. ## @end table ## @end deftypefn - -## See also: cond, svd +## @seealso{cond, svd} ## Author: jwe
--- a/scripts/miscellaneous/comma.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/miscellaneous/comma.m Thu Jan 06 03:14:17 2000 +0000 @@ -17,6 +17,7 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. +## @deftypefn {Operator} {} , ## Array index, function argument, or command separator. -## -## See also: semicolon +## @end deftypefn +## @seealso{semicolon}
--- a/scripts/miscellaneous/etime.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/miscellaneous/etime.m Thu Jan 06 03:14:17 2000 +0000 @@ -32,8 +32,7 @@ ## will set the variable @code{elapsed_time} to the number of seconds since ## the variable @code{t0} was set. ## @end deftypefn - -## See also: tic, toc, clock, cputime +## @seealso{tic, toc, clock, cputime} ## Author: jwe
--- a/scripts/miscellaneous/menu.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/miscellaneous/menu.m Thu Jan 06 03:14:17 2000 +0000 @@ -26,8 +26,7 @@ ## in, but it may be confusing to present more than will fit easily on one ## screen. ## @end deftypefn - -## See also: disp, printf, input +## @seealso{disp, printf, input} ## Author: jwe
--- a/scripts/miscellaneous/semicolon.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/miscellaneous/semicolon.m Thu Jan 06 03:14:17 2000 +0000 @@ -17,6 +17,7 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. +## @deftypefn {Operator} {} : () ## Array row or command separator. -## -## See also: comma +## @end deftypefn +## @seealso{comma}
--- a/scripts/miscellaneous/texas_lotto.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/miscellaneous/texas_lotto.m Thu Jan 06 03:14:17 2000 +0000 @@ -17,12 +17,12 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: texas_lotto +## @deftypefn {Function File } {@var{winning_numbers} =} texas_lotto () ## ## Pick 6 unique numbers between 1 and 50 that are guaranteed to win ## the Texas Lotto. -## -## See also: rand +## @end deftypefn +## @seealso{rand} ## Author: jwe
--- a/scripts/plot/__pltopt1__.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/__pltopt1__.m Thu Jan 06 03:14:17 2000 +0000 @@ -17,11 +17,12 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: fmt = __pltopt1__ (caller, opt) +## -*- texinfo -*- +## @deftypefn {Function File} {@var{fmt} =} __pltopt1__ (@var{caller}, @var{opt}) ## ## Really decode plot option strings. -## -## See also: __pltopt__ +## @end deftypefn +## @seealso{ __pltopt__} ## Author: Rick Niles <niles@axp745.gsfc.nasa.gov> ## Adapted-By: jwe
--- a/scripts/plot/__pltopt__.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/__pltopt__.m Thu Jan 06 03:14:17 2000 +0000 @@ -61,7 +61,7 @@ ## 5 cyan cyan dot long dash triangle filled square ## 6 brown yellow dot short dash "*" "o" ## -## See also: __pltopt1__ +## @seealso{__pltopt1__} ## Author: jwe ## Adapted-By: jwe
--- a/scripts/plot/bar.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/bar.m Thu Jan 06 03:14:17 2000 +0000 @@ -42,9 +42,8 @@ ## @noindent ## are equivalent. ## @end deftypefn - -## See also: plot, semilogx, semilogy, loglog, polar, mesh, contour, -## stairs, gplot, gsplot, replot, xlabel, ylabel, title +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## stairs, gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/contour.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/contour.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,9 +23,8 @@ ## @var{z}. Someone needs to improve @code{gnuplot}'s contour routines ## before this will be very useful. ## @end deftypefn - -## See also: plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/grid.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/grid.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,9 +23,8 @@ ## The argument may be either @code{"on"} or @code{"off"}. If it is ## omitted, @code{"on"} is assumed. ## @end deftypefn - -## See also: plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/hist.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/hist.m Thu Jan 06 03:14:17 2000 +0000 @@ -36,8 +36,7 @@ ## With two output arguments, produce the values @var{nn} and @var{xx} such ## that @code{bar (@var{xx}, @var{nn})} will plot the histogram. ## @end deftypefn - -## See also: bar +## @seealso{bar} ## Author: jwe
--- a/scripts/plot/loglog.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/loglog.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,9 +23,8 @@ ## description of @code{plot} for a description of the arguments that ## @code{loglog} will accept. ## @end deftypefn - -## See also: plot, semilogy, loglog, polar, mesh, contour, bar, stairs, -## gplot, gsplot, replot, xlabel, ylabel, title +## @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, +## gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/mesh.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/mesh.m Thu Jan 06 03:14:17 2000 +0000 @@ -26,9 +26,8 @@ ## correspond to different @var{x} values and rows of @var{z} correspond ## to different @var{y} values. ## @end deftypefn - -## See also: plot, semilogx, semilogy, loglog, polar, meshgrid, meshdom, -## contour, bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title +## @seealso{plot, semilogx, semilogy, loglog, polar, meshgrid, meshdom, +## contour, bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/meshgrid.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/meshgrid.m Thu Jan 06 03:14:17 2000 +0000 @@ -17,18 +17,15 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: [xx, yy] = meshgrid (x, y) -## -## Given vectors of x and y coordinates, return two matrices corresponding -## to the x and y coordinates of a mesh. The rows of xx are copies of x, -## and the columns of yy are copies of y. -## -## [xx, yy] = meshgrid (x) is an abbreviation for [xx, yy] = meshgrid (x, x). -## -## See sombrero.m for an example of using meshgrid. -## -## See also: plot, semilogx, semilogy, loglog, polar, mesh, meshdom, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title +## -*- texinfo -*- +## @deftypefn {Function File} {[@var{xx}, @var{yy}] =} meshgrid (@var{x}, @var{y}) +## @deftypefnx {Function File {[@var{xx}, @var{yy}] =} meshgrid (@var{x}) +## Given vectors of @var{x} and @var{y} coordinates, return two matrices corresponding +## to the @var{x} and @var{y} coordinates of a mesh. The rows of @var{xx} are copies of @var{x}, +## and the columns of @var{yy} are copies of @var{y}. +## @end deftypefn +## @seealso{sombrero, plot, semilogx, semilogy, loglog, polar, mesh, meshdom, contour, +## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/plot.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/plot.m Thu Jan 06 03:14:17 2000 +0000 @@ -155,9 +155,8 @@ ## This command will plot the data in the variable @code{b} will be plotted ## with points displayed as @samp{*}. ## @end deftypefn - -## See also: semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__ -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title +## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__ +## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/polar.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/polar.m Thu Jan 06 03:14:17 2000 +0000 @@ -24,9 +24,8 @@ ## ## The optional third argument specifies the line type. ## @end deftypefn - -## See also: plot, semilogx, semilogy, loglog, mesh, contour, bar, -## stairs, gplot, gsplot, replot, xlabel, ylabel, title +## @seealso{plot, semilogx, semilogy, loglog, mesh, contour, bar, +## stairs, gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/semilogx.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/semilogx.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,9 +23,8 @@ ## the description of @code{plot} for a description of the arguments ## that @code{semilogx} will accept. ## @end deftypefn - -## See also: plot, semilogy, loglog, polar, mesh, contour, bar, stairs, -## gplot, gsplot, replot, xlabel, ylabel, title +## @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, +## gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/semilogy.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/semilogy.m Thu Jan 06 03:14:17 2000 +0000 @@ -23,9 +23,8 @@ ## the description of @code{plot} for a description of the arguments ## that @code{semilogy} will accept. ## @end deftypefn - -## See also: plot, semilogx, loglog, polar, mesh, contour, bar, stairs, -## gplot, gsplot, replot, xlabel, ylabel, title +## @seealso{plot, semilogx, loglog, polar, mesh, contour, bar, stairs, +## gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/shg.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/shg.m Thu Jan 06 03:14:17 2000 +0000 @@ -17,13 +17,15 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: shg +## -*- texinfo -*- +## @deftypefn {Function File} {} shg ## ## Show the graph window. Currently, this is the same as executing ## replot without any arguments. -## -## See also: plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel +## +## @end deftypefn +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, stairs, gplot, gsplot, replot, xlabel, ylabel} ## Author: jwe
--- a/scripts/plot/stairs.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/stairs.m Thu Jan 06 03:14:17 2000 +0000 @@ -42,9 +42,8 @@ ## @noindent ## are equivalent. ## @end deftypefn - -## See also: plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, gplot, gsplot, replot, xlabel, ylabel, title +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, gplot, gsplot, replot, xlabel, ylabel, title} ## Author: jwe
--- a/scripts/plot/title.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/title.m Thu Jan 06 03:14:17 2000 +0000 @@ -22,9 +22,8 @@ ## Specify a title for a plot. If you already have a plot displayed, use ## the command @code{replot} to redisplay it with the new title. ## @end deftypefn - -## See also: plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, stairs, gplot, gsplot, replot, xlabel, ylabel} ## Author: jwe
--- a/scripts/plot/xlabel.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/plot/xlabel.m Thu Jan 06 03:14:17 2000 +0000 @@ -25,9 +25,8 @@ ## displayed, use the command @code{replot} to redisplay it with the new ## labels. ## @end deftypefn - -## See also: plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, ylabel, title +## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, +## bar, stairs, gplot, gsplot, replot, ylabel, title} ## Author: jwe
--- a/scripts/specfun/erfinv.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/specfun/erfinv.m Thu Jan 06 03:14:17 2000 +0000 @@ -18,8 +18,7 @@ ## @deftypefn {Mapping Function} {} erfinv (@var{z}) ## Computes the inverse of the error function, ## @end deftypefn - -## See also: erf, erfc +## @seealso{erf, erfc} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Created: 27 September 1994
--- a/scripts/specfun/gammai.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/specfun/gammai.m Thu Jan 06 03:14:17 2000 +0000 @@ -44,8 +44,7 @@ ## If neither @var{a} nor @var{x} is scalar, the sizes of @var{a} and ## @var{x} must agree, and @var{gammai} is applied element-by-element. ## @end deftypefn - -## See also: gamma, lgamma +## @seealso{gamma, lgamma} ## Author: jwe ## Created: 30 Jan 1998
--- a/scripts/specfun/log2.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/specfun/log2.m Thu Jan 06 03:14:17 2000 +0000 @@ -28,8 +28,7 @@ ## 1/2 <= abs(f) < 1 and x = f * 2^e. ## @end ifinfo ## @end deftypefn - -## See also: log, log10, logspace, exp +## @seealso{log, log10, logspace, exp} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 17 October 1994
--- a/scripts/specfun/pow2.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/specfun/pow2.m Thu Jan 06 03:14:17 2000 +0000 @@ -36,8 +36,7 @@ ## f .* (2 .^ e). ## @end ifinfo ## @end deftypefn - -## See also: nextpow2 +## @seealso{nextpow2} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 17 October 1994
--- a/scripts/special-matrix/hankel.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/special-matrix/hankel.m Thu Jan 06 03:14:17 2000 +0000 @@ -44,8 +44,7 @@ ## @end example ## @end ifinfo ## @end deftypefn - -## See also: vander, sylvester_matrix, hilb, invhilb, toeplitz +## @seealso{vander, sylvester_matrix, hilb, invhilb, toeplitz} ## Author: jwe
--- a/scripts/special-matrix/hilb.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/special-matrix/hilb.m Thu Jan 06 03:14:17 2000 +0000 @@ -43,8 +43,7 @@ ## @end example ## @end ifinfo ## @end deftypefn - -## See also: hankel, vander, sylvester_matrix, invhilb, toeplitz +## @seealso{hankel, vander, sylvester_matrix, invhilb, toeplitz} ## Author: jwe
--- a/scripts/special-matrix/invhilb.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/special-matrix/invhilb.m Thu Jan 06 03:14:17 2000 +0000 @@ -24,8 +24,7 @@ ## which suffers from the ill-conditioning of the Hilbert matrix, and the ## finite precision of your computer's floating point arithmetic. ## @end deftypefn - -## See also: hankel, vander, sylvester_matrix, hilb, toeplitz +## @seealso{hankel, vander, sylvester_matrix, hilb, toeplitz} ## Author: jwe
--- a/scripts/special-matrix/sylvester_matrix.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/special-matrix/sylvester_matrix.m Thu Jan 06 03:14:17 2000 +0000 @@ -29,8 +29,7 @@ ## n = 2^k. ## @end ifinfo ## @end deftypefn - -## See also: hankel, vander, hilb, invhilb, toeplitz +## @seealso{hankel, vander, hilb, invhilb, toeplitz} ## Author: jwe
--- a/scripts/special-matrix/toeplitz.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/special-matrix/toeplitz.m Thu Jan 06 03:14:17 2000 +0000 @@ -53,8 +53,7 @@ ## @end example ## @end ifinfo ## @end deftypefn - -## See also: hankel, vander, sylvester_matrix, hilb, invhib +## @seealso{hankel, vander, sylvester_matrix, hilb, invhib} ## Author: jwe
--- a/scripts/special-matrix/vander.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/special-matrix/vander.m Thu Jan 06 03:14:17 2000 +0000 @@ -47,8 +47,7 @@ ## @end example ## @end ifinfo ## @end deftypefn - -## See also: hankel, sylvester_matrix, hilb, invhilb, toeplitz +## @seealso{hankel, sylvester_matrix, hilb, invhilb, toeplitz} ## Author: jwe
--- a/scripts/statistics/base/median.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/statistics/base/median.m Thu Jan 06 03:14:17 2000 +0000 @@ -43,8 +43,7 @@ ## If @var{x} is a matrix, compute the median value for each ## column and return them in a row vector. ## @end deftypefn - -## See also: std, mean +## @seealso{std, mean} ## Author: jwe
--- a/scripts/statistics/base/std.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/statistics/base/std.m Thu Jan 06 03:14:17 2000 +0000 @@ -39,8 +39,7 @@ ## If @var{x} is a matrix, compute the standard deviation for ## each column and return them in a row vector. ## @end deftypefn - -## See also: mean, median +## @seealso{mean, median} ## Author: jwe
--- a/scripts/strings/isletter.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/strings/isletter.m Thu Jan 06 03:14:17 2000 +0000 @@ -17,9 +17,10 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: isletter (s) -## -## See also: isalpha +## @deftypefn {Function File } { @var{bool} =} isletter(@var{s}) +## Returns true if @var{s} is a letter false otherwise. +## @end deftypefn +## @seealso{isalpha} ## Author: jwe
--- a/scripts/strings/lower.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/strings/lower.m Thu Jan 06 03:14:17 2000 +0000 @@ -17,9 +17,9 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: lower (s) -## -## See also: tolower +## @deftypefn {Function File} {@var{s} =} lower(@var{S}) +## @end deftypefn +## @seealso{tolower} ## Author: jwe
--- a/scripts/strings/upper.m Wed Jan 05 20:51:47 2000 +0000 +++ b/scripts/strings/upper.m Thu Jan 06 03:14:17 2000 +0000 @@ -17,9 +17,10 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: upper (s) -## -## See also: toupper +## @deftypefn {Function File} {@var{S} =} upper(@var{s}) +## Transform all letters in a string to upper case. +## @end deftypefn +## @seealso{toupper} ## Author: jwe