Mercurial > hg > octave-max
changeset 3408:ae7adbb591e8
[project @ 2000-01-06 08:29:11 by jwe]
line wrap: on
line diff
--- a/scripts/audio/lin2mu.m +++ b/scripts/audio/lin2mu.m @@ -23,7 +23,7 @@ ## linear encoding, @code{lin2mu (@var{x})} is the corresponding mu-law ## encoding. ## @end deftypefn -## @seealso{mu2lin, loadaudio, saveaudio, playaudio, setaudio, record} +## @seealso{mu2lin, loadaudio, saveaudio, playaudio, setaudio, and record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 17 October 1994
--- a/scripts/audio/loadaudio.m +++ b/scripts/audio/loadaudio.m @@ -30,7 +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 -## @seealso{lin2mu, mu2lin, saveaudio, playaudio, setaudio, record} +## @seealso{lin2mu, mu2lin, saveaudio, playaudio, setaudio, and record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 10 April 1994
--- a/scripts/audio/mu2lin.m +++ b/scripts/audio/mu2lin.m @@ -24,7 +24,7 @@ ## @var{bps} specifies whether the input data uses 8 bit per sample ## (default) or 16 bit. ## @end deftypefn -## @seealso{lin2mu, loadaudio, saveaudio, playaudio, setaudio, record} +## @seealso{lin2mu, loadaudio, saveaudio, playaudio, setaudio, and record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 18 October 1994
--- a/scripts/audio/playaudio.m +++ b/scripts/audio/playaudio.m @@ -23,7 +23,7 @@ ## Plays the audio file @file{@var{name}.@var{ext}} or the audio data ## stored in the vector @var{x}. ## @end deftypefn -## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, setaudio, record} +## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, setaudio, and record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 11 April 1994
--- a/scripts/audio/record.m +++ b/scripts/audio/record.m @@ -24,7 +24,7 @@ ## 8kHz. The program waits until the user types @key{RET} and then ## immediately starts to record. ## @end deftypefn -## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, playaudio, setaudio} +## @seealso{lin2mu, mu2lin, loadaudio, saveaudio, playaudio, and setaudio} ## usage: X = record (sec [, sampling_rate]) ##
--- a/scripts/audio/saveaudio.m +++ b/scripts/audio/saveaudio.m @@ -25,7 +25,7 @@ ## in the audio file (see @code{loadaudio}); defaults are @file{lin} and ## 8, respectively. ## @end deftypefn -## @seealso{lin2mu, mu2lin, loadaudio, playaudio, setaudio, record} +## @seealso{lin2mu, mu2lin, loadaudio, playaudio, setaudio, and record} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 5 September 1994
--- a/scripts/control/are.m +++ b/scripts/control/are.m @@ -58,7 +58,7 @@ ## matrix. ## ## @end deftypefn -## @seealso{balance, dare} +## @seealso{balance and dare} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/dare.m +++ b/scripts/control/dare.m @@ -68,7 +68,7 @@ ## Systems, Vol 5, no 2 (1992) pp 165-194. ## ## @end deftypefn -## @seealso{balance, are} +## @seealso{balance and are} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/impulse.m +++ b/scripts/control/impulse.m @@ -41,7 +41,7 @@ ## @strong{Outputs} ## @var{y}, @var{t}: impulse response ## @end deftypefn -## @seealso{step, stepimp} +## @seealso{step and stepimp} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: October 2, 1997
--- a/scripts/control/is_controllable.m +++ b/scripts/control/is_controllable.m @@ -36,7 +36,8 @@ ## @table @var ## @item retval ## Logical flag; returns true (1) if the system @var{sys} or the -## pair (@var{a},@var{b}) is controllable, whichever was passed as input arguments. +## pair (@var{a},@var{b}) is controllable, whichever was passed as input +## arguments. ## @item U ## U is an orthogonal basis of the controllable subspace. ## @end table @@ -48,11 +49,13 @@ ## @example ## span ([b,a*b,...,a^@{n-1@}*b]). ## @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}. +## 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}. ## ## @end deftypefn ## @seealso{size, rows, columns, length, is_matrix, is_scalar, is_vector -## is_observable, is_stabilizable, is_detectable, krylov, krylovb} +## is_observable, is_stabilizable, is_detectable, krylov, and krylovb} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/is_detectable.m +++ b/scripts/control/is_detectable.m @@ -24,13 +24,14 @@ ## Returns 1 if the system @var{a} or the pair (@var{a},@var{c})is ## detectable, 0 if not. ## -## @strong{See} @code{is_stabilizable} for detailed description of arguments and -## computational method. +## @strong{See} @code{is_stabilizable} for detailed description of +## arguments and computational method. ## ## Default: tol = 10*norm(a,'fro')*eps ## ## @end deftypefn -## @seealso{is_stabilizable, size, rows, columns, length, is_matrix, is_scalar, is_vector} +## @seealso{is_stabilizable, size, rows, columns, length, is_matrix, +## is_scalar, and is_vector} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/is_observable.m +++ b/scripts/control/is_observable.m @@ -29,7 +29,7 @@ ## @strong{See} @code{is_controllable} for detailed description of arguments ## and default values. ## @end deftypefn -## @seealso{size, rows, columns, length, is_matrix, is_scalar, is_vector} +## @seealso{size, rows, columns, length, is_matrix, is_scalar, and is_vector} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/is_stable.m +++ b/scripts/control/is_stable.m @@ -38,7 +38,7 @@ ## @end table ## @end deftypefn ## @seealso{size, rows, columns, length, is_matrix, is_scalar, is_vector -## is_observable, is_stabilizable, is_detectable, krylov, krylovb} +## is_observable, is_stabilizable, is_detectable, krylov, and krylovb} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1993
--- a/scripts/control/lqg.m +++ b/scripts/control/lqg.m @@ -15,7 +15,7 @@ ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, write to the Free ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. - + ## -*- texinfo -*- ## @deftypefn {Function File } {[@var{K}, @var{Q}, @var{P}, @var{Ee}, @var{Er}] =} lqg(@var{sys}, @var{Sigw}, @var{Sigv}, @var{Q}, @var{R}, @var{in_idx}) ## Design a linear-quadratic-gaussian optimal controller for the system @@ -33,9 +33,11 @@ ## @table @var ## @item sys ## system data structure -## @item Sigw, Sigv +## @item Sigw +## @itemx Sigv ## intensities of independent Gaussian noise processes (as above) -## @item Q, R +## @item Q +## @itemx R ## state, control weighting respectively. Control ARE is ## @item in_idx ## indices of controlled inputs @@ -46,8 +48,9 @@ ## @strong{Outputs} ## @table @var ## @item K -## system data structure format LQG optimal controller -## (Obtain A,B,C matrices with @code{sys2ss}, @code{sys2tf}, or @code{sys2zp} as appropriate) +## system data structure format LQG optimal controller (Obtain A,B,C +## matrices with @code{sys2ss}, @code{sys2tf}, or @code{sys2zp} as +## appropriate) ## @item P ## Solution of control (state feedback) algebraic Riccati equation ## @item Q @@ -58,7 +61,7 @@ ## controller poles ## @end table ## @end deftypefn -## @seealso{h2syn, lqe, lqr} +## @seealso{h2syn, lqe, and lqr} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: August 1995
--- a/scripts/control/polyout.m +++ b/scripts/control/polyout.m @@ -17,7 +17,7 @@ ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. ## -*- texinfo -*- -## @deftypefn {Function File } { @var{y} =} polyout ( @var{c}@{, @var{x}@}) +## @deftypefn {Function File} {@var{y} =} polyout (@var{c}@{, @var{x}@}) ## write formatted polynomial ## @example ## c(x) = c(1) * x^n + ... + c(n) x + c(n+1) @@ -26,7 +26,7 @@ ## @var{x} defaults to the string @code{"s"} ## @end deftypefn ## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, -## filter, polyderiv, polyinteg} +## filter, polyderiv, and polyinteg} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: May 1995
--- a/scripts/control/step.m +++ b/scripts/control/step.m @@ -43,7 +43,7 @@ ## ## When invoked with the output paramter y the plot is not displayed. ## @end deftypefn -## @seealso{impulse, stepimp} +## @seealso{impulse and stepimp} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: September 30, 1997
--- a/scripts/control/stepimp.m +++ b/scripts/control/stepimp.m @@ -29,7 +29,7 @@ ## or @code{impulse} instead. ## ## @end deftypefn -## @seealso{step, impulse} +## @seealso{step and impulse} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: October 2, 1997
--- a/scripts/control/sysdimensions.m +++ b/scripts/control/sysdimensions.m @@ -63,7 +63,7 @@ ## @end table ## ## @end deftypefn -## @seealso{sysgetsignals, sysgettsam} +## @seealso{sysgetsignals and sysgettsam} function [n, nz, m, p, yd] = sysdimensions (sys, opt)
--- a/scripts/control/sysupdate.m +++ b/scripts/control/sysupdate.m @@ -45,7 +45,7 @@ ## Conversion to @code{tf} or @code{zp} exits with an error if the system is ## mixed continuous/digital. ## @end deftypefn -## seealso{tf2sys, ss2sys, zp2sys, sysout, sys2ss, sys2tf, sys2zp} +## @seealso{tf2sys, ss2sys, zp2sys, sysout, sys2ss, sys2tf, and sys2zp} ## Author: John Ingram <ingraje@eng.auburn.edu> ## Created: July 9, 1996
--- a/scripts/control/tfout.m +++ b/scripts/control/tfout.m @@ -15,14 +15,14 @@ ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, write to the Free ## Software Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. - + ## -*- texinfo -*- ## @deftypefn {Function File } { } tfout (@var{num}, @var{denom}@{, @var{x}@}) -## print formatted transfer function @math{n(s)/d(s) } to the screen -## @var{x} defaults to the string @code{"s"} +## Print formatted transfer function @math{n(s)/d(s) } to the screen. +## @var{x} defaults to the string @code{"s"} ## @end deftypefn ## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, -## filter, polyderiv, polyinteg, polyout} +## filter, polyderiv, polyinteg, and polyout} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: June 1995
--- a/scripts/control/ugain.m +++ b/scripts/control/ugain.m @@ -24,7 +24,7 @@ ## Watch out if you are forming sampled systems since "ugain" ## does not contain a sampling period. ## @end deftypefn -## @seealso{hinfdemo (MIMO H_infinty example, Boeing 707-321 aircraft model)} +## @seealso{hinfdemo and jet707} ## Author: Kai P. Mueller <mueller@ifr.ing.tu-bs.de> ## Created: April 1998
--- a/scripts/control/zpout.m +++ b/scripts/control/zpout.m @@ -22,7 +22,7 @@ ## @var{x} defaults to the string @code{"s"} ## @end deftypefn ## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, -## filter, polyderiv, polyinteg, polyout} +## filter, polyderiv, polyinteg, and polyout} ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu> ## Created: June 1995
--- a/scripts/elfun/gcd.m +++ b/scripts/elfun/gcd.m @@ -40,7 +40,7 @@ ## g = v(1) * a(k) + ... + v(k) * a(k) ## @end example ## @end deftypefn -## @seealso{lcm, min, max, ceil, floor} +## @seealso{lcm, min, max, ceil, and floor} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Created: 16 September 1994
--- a/scripts/elfun/lcm.m +++ b/scripts/elfun/lcm.m @@ -33,7 +33,7 @@ ## lcm ([a1, ..., ak]). ## @end example ## @end deftypefn -## @seealso{gcd, min, max, ceil, floor} +## @seealso{gcd, min, max, ceil, and floor} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Created: 16 September 1994
--- a/scripts/finance/nper.m +++ b/scripts/finance/nper.m @@ -29,7 +29,7 @@ ## Note that the rate r is not specified in percent, i.e., one has to ## write 0.05 rather than 5 %. ## @end deftypefn -## @seealso{pv, pmt, rate, npv} +## @seealso{pv, pmt, rate, and npv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Number of payments needed for amortizing a loan
--- a/scripts/finance/npv.m +++ b/scripts/finance/npv.m @@ -28,7 +28,7 @@ ## Note that rates are not specified in percent, i.e., one has to write ## 0.05 rather than 5 %. ## @end deftypefn -## @seealso{irr, pv} +## @seealso{irr and pv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Net present value of a series of payments
--- a/scripts/finance/pmt.m +++ b/scripts/finance/pmt.m @@ -24,7 +24,7 @@ ## specify whether payments are made at the end ("e", default) or at the ## beginning ("b") of each period. ## @end deftypefn -## @seealso{pv, nper, rate} +## @seealso{pv, nper, and rate} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Amount of periodic payment needed to amortize a loan
--- a/scripts/finance/pv.m +++ b/scripts/finance/pv.m @@ -29,7 +29,7 @@ ## Note that the rate r is not specified in percent, i.e., one has to ## write 0.05 rather than 5 %. ## @end deftypefn -## @seealso{pmt, nper, rate, npv} +## @seealso{pmt, nper, rate, and npv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Present value of an investment
--- a/scripts/finance/rate.m +++ b/scripts/finance/rate.m @@ -24,7 +24,7 @@ ## string argument @var{`method'}, one can specify whether payments are made ## at the end ("e", default) or at the beginning ("b") of each period. ## @end deftypefn -## @seealso{pv, pmt, nper, npv} +## @seealso{pv, pmt, nper, and npv} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Description: Rate of return of an investment
--- a/scripts/general/columns.m +++ b/scripts/general/columns.m @@ -21,7 +21,7 @@ ## @deftypefn {Function File} {} columns (@var{a}) ## Return the number of columns of @var{a}. ## @end deftypefn -## @seealso{size, rows, length, is_scalar, is_vector, is_matrix} +## @seealso{size, rows, length, is_scalar, is_vector, and is_matrix} ## Author: jwe
--- a/scripts/general/fliplr.m +++ b/scripts/general/fliplr.m @@ -30,7 +30,7 @@ ## @end group ## @end example ## @end deftypefn -## @seealso{flipud, rot90} +## @seealso{flipud and rot90} ## Author: jwe
--- a/scripts/general/flipud.m +++ b/scripts/general/flipud.m @@ -30,7 +30,7 @@ ## @end group ## @end example ## @end deftypefn -## @seealso{fliplr, rot90} +## @seealso{fliplr and rot90} ## Author: jwe
--- a/scripts/general/int2str.m +++ b/scripts/general/int2str.m @@ -24,7 +24,7 @@ ## but are provided for compatibility with @sc{Matlab}. For better control ## over the results, use @code{sprintf} (@pxref{Formatted Output}). ## @end deftypefn -## @seealso{sprintf, num2str} +## @seealso{sprintf and num2str} ## Author: jwe
--- a/scripts/general/is_scalar.m +++ b/scripts/general/is_scalar.m @@ -21,7 +21,7 @@ ## @deftypefn {Function File} {} is_scalar (@var{a}) ## Return 1 if @var{a} is a scalar. Otherwise, return 0. ## @end deftypefn -## @seealso{size, rows, columns, length, is_scalar, is_matrix} +## @seealso{size, rows, columns, length, is_scalar, and is_matrix} ## Author: jwe
--- a/scripts/general/is_square.m +++ b/scripts/general/is_square.m @@ -22,7 +22,7 @@ ## If @var{x} is a square matrix, then return the dimension of @var{x}. ## Otherwise, return 0. ## @end deftypefn -## @seealso{size, rows, columns, length, is_matrix, is_scalar, is_vector} +## @seealso{size, rows, columns, length, is_matrix, is_scalar, and is_vector} ## Author: A. S. Hodel <scotte@eng.auburn.edu> ## Created: August 1993
--- a/scripts/general/is_symmetric.m +++ b/scripts/general/is_symmetric.m @@ -24,7 +24,7 @@ ## @var{tol} is omitted, use a tolerance equal to the machine precision. ## @end deftypefn ## @seealso{size, rows, columns, length, is_matrix, is_scalar, -## is_square, is_vector} +## is_square, and is_vector} ## Author: A. S. Hodel <scotte@eng.auburn.edu> ## Created: August 1993
--- a/scripts/general/is_vector.m +++ b/scripts/general/is_vector.m @@ -21,7 +21,7 @@ ## @deftypefn {Function File} {} is_vector (@var{a}) ## Return 1 if @var{a} is a vector. Otherwise, return 0. ## @end deftypefn -## @seealso{size, rows, columns, length, is_scalar, is_matrix} +## @seealso{size, rows, columns, length, is_scalar, and is_matrix} ## Author: jwe
--- a/scripts/general/num2str.m +++ b/scripts/general/num2str.m @@ -24,7 +24,7 @@ ## but are provided for compatibility with @sc{Matlab}. For better control ## over the results, use @code{sprintf} (@pxref{Formatted Output}). ## @end deftypefn -## @seealso{sprintf, int2str} +## @seealso{sprintf and int2str} ## Author: jwe
--- a/scripts/general/reshape.m +++ b/scripts/general/reshape.m @@ -49,7 +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 -## @seealso{`:', do_fortran_indexing} +## @seealso{`:' and do_fortran_indexing} ## Author: jwe
--- a/scripts/general/rot90.m +++ b/scripts/general/rot90.m @@ -47,7 +47,7 @@ ## @end group ## @end example ## @end deftypefn -## @seealso{flipud, fliplr} +## @seealso{flipud and fliplr} ## Author: jwe
--- a/scripts/general/rows.m +++ b/scripts/general/rows.m @@ -21,7 +21,7 @@ ## @deftypefn {Function File} {} rows (@var{a}) ## Return the number of rows of @var{a}. ## @end deftypefn -## @seealso{size, columns, length, is_scalar, is_vector, is_matrix} +## @seealso{size, columns, length, is_scalar, is_vector, and is_matrix} ## Author: jwe
--- a/scripts/general/tril.m +++ b/scripts/general/tril.m @@ -60,7 +60,7 @@ ## @end group ## @end example ## @end deftypefn -## @seealso{triu, diag} +## @seealso{triu and diag} ## Author: jwe
--- a/scripts/linear-algebra/cond.m +++ b/scripts/linear-algebra/cond.m @@ -23,7 +23,7 @@ ## defined as @code{norm (a) * norm (inv (a))}, and is computed via a ## singular value decomposition. ## @end deftypefn -## @seealso{norm, svd, rank} +## @seealso{norm, svd, and rank} ## Author: jwe
--- a/scripts/linear-algebra/norm.m +++ b/scripts/linear-algebra/norm.m @@ -53,7 +53,7 @@ ## p-norm of @var{a}, @code{(sum (abs (@var{a}) .^ @var{p})) ^ (1/@var{p})}. ## @end table ## @end deftypefn -## @seealso{cond, svd} +## @seealso{cond and svd} ## Author: jwe
--- a/scripts/miscellaneous/etime.m +++ b/scripts/miscellaneous/etime.m @@ -32,7 +32,7 @@ ## will set the variable @code{elapsed_time} to the number of seconds since ## the variable @code{t0} was set. ## @end deftypefn -## @seealso{tic, toc, clock, cputime} +## @seealso{tic, toc, clock, and cputime} ## Author: jwe
--- a/scripts/miscellaneous/menu.m +++ b/scripts/miscellaneous/menu.m @@ -26,7 +26,7 @@ ## in, but it may be confusing to present more than will fit easily on one ## screen. ## @end deftypefn -## @seealso{disp, printf, input} +## @seealso{disp, printf, and input} ## Author: jwe
--- a/scripts/plot/__pltopt1__.m +++ b/scripts/plot/__pltopt1__.m @@ -22,7 +22,7 @@ ## ## Really decode plot option strings. ## @end deftypefn -## @seealso{ __pltopt__} +## @seealso{__pltopt__} ## Author: Rick Niles <niles@axp745.gsfc.nasa.gov> ## Adapted-By: jwe
--- a/scripts/plot/bar.m +++ b/scripts/plot/bar.m @@ -43,7 +43,7 @@ ## are equivalent. ## @end deftypefn ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## stairs, gplot, gsplot, replot, xlabel, ylabel, title} +## stairs, gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/contour.m +++ b/scripts/plot/contour.m @@ -24,7 +24,7 @@ ## before this will be very useful. ## @end deftypefn ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title} +## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/grid.m +++ b/scripts/plot/grid.m @@ -24,7 +24,7 @@ ## omitted, @code{"on"} is assumed. ## @end deftypefn ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title} +## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/loglog.m +++ b/scripts/plot/loglog.m @@ -24,7 +24,7 @@ ## @code{loglog} will accept. ## @end deftypefn ## @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, -## gplot, gsplot, replot, xlabel, ylabel, title} +## gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/mesh.m +++ b/scripts/plot/mesh.m @@ -27,7 +27,7 @@ ## to different @var{y} values. ## @end deftypefn ## @seealso{plot, semilogx, semilogy, loglog, polar, meshgrid, meshdom, -## contour, bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title} +## contour, bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/meshgrid.m +++ b/scripts/plot/meshgrid.m @@ -25,7 +25,7 @@ ## 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} +## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/plot.m +++ b/scripts/plot/plot.m @@ -156,7 +156,7 @@ ## with points displayed as @samp{*}. ## @end deftypefn ## @seealso{semilogx, semilogy, loglog, polar, mesh, contour, __pltopt__ -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, title} +## bar, stairs, gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/polar.m +++ b/scripts/plot/polar.m @@ -25,7 +25,7 @@ ## The optional third argument specifies the line type. ## @end deftypefn ## @seealso{plot, semilogx, semilogy, loglog, mesh, contour, bar, -## stairs, gplot, gsplot, replot, xlabel, ylabel, title} +## stairs, gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/semilogx.m +++ b/scripts/plot/semilogx.m @@ -24,7 +24,7 @@ ## that @code{semilogx} will accept. ## @end deftypefn ## @seealso{plot, semilogy, loglog, polar, mesh, contour, bar, stairs, -## gplot, gsplot, replot, xlabel, ylabel, title} +## gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/semilogy.m +++ b/scripts/plot/semilogy.m @@ -24,7 +24,7 @@ ## that @code{semilogy} will accept. ## @end deftypefn ## @seealso{plot, semilogx, loglog, polar, mesh, contour, bar, stairs, -## gplot, gsplot, replot, xlabel, ylabel, title} +## gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/shg.m +++ b/scripts/plot/shg.m @@ -25,7 +25,7 @@ ## ## @end deftypefn ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel} +## bar, stairs, gplot, gsplot, replot, xlabel, and ylabel} ## Author: jwe
--- a/scripts/plot/stairs.m +++ b/scripts/plot/stairs.m @@ -43,7 +43,7 @@ ## are equivalent. ## @end deftypefn ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, gplot, gsplot, replot, xlabel, ylabel, title} +## bar, gplot, gsplot, replot, xlabel, ylabel, and title} ## Author: jwe
--- a/scripts/plot/title.m +++ b/scripts/plot/title.m @@ -23,7 +23,7 @@ ## the command @code{replot} to redisplay it with the new title. ## @end deftypefn ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, xlabel, ylabel} +## bar, stairs, gplot, gsplot, replot, xlabel, and ylabel} ## Author: jwe
--- a/scripts/plot/xlabel.m +++ b/scripts/plot/xlabel.m @@ -26,7 +26,7 @@ ## labels. ## @end deftypefn ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, gplot, gsplot, replot, ylabel, title} +## bar, stairs, gplot, gsplot, replot, ylabel, and title} ## Author: jwe
--- a/scripts/set/complement.m +++ b/scripts/set/complement.m @@ -28,9 +28,8 @@ ## @result{} 5 ## @end group ## @end example -## +## @end deftypefn ## @seealso{create_set, union, and intersection} -## @end deftypefn ## Author: jwe
--- a/scripts/set/create_set.m +++ b/scripts/set/create_set.m @@ -28,9 +28,8 @@ ## @result{} [ 1, 2, 3, 4 ] ## @end group ## @end example -## +## @end deftypefn ## @seealso{union, intersection, and complement} -## @end deftypefn ## Author: jwe
--- a/scripts/set/intersection.m +++ b/scripts/set/intersection.m @@ -28,9 +28,8 @@ ## @result{} [ 2, 3 ] ## @end group ## @end example -## +## @end deftypefn ## @seealso{create_set, union, and complement} -## @end deftypefn ## Author: jwe
--- a/scripts/specfun/erfinv.m +++ b/scripts/specfun/erfinv.m @@ -18,7 +18,7 @@ ## @deftypefn {Mapping Function} {} erfinv (@var{z}) ## Computes the inverse of the error function, ## @end deftypefn -## @seealso{erf, erfc} +## @seealso{erf and erfc} ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Created: 27 September 1994
--- a/scripts/specfun/gammai.m +++ b/scripts/specfun/gammai.m @@ -44,7 +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 -## @seealso{gamma, lgamma} +## @seealso{gamma and lgamma} ## Author: jwe ## Created: 30 Jan 1998
--- a/scripts/specfun/log2.m +++ b/scripts/specfun/log2.m @@ -28,7 +28,7 @@ ## 1/2 <= abs(f) < 1 and x = f * 2^e. ## @end ifinfo ## @end deftypefn -## @seealso{log, log10, logspace, exp} +## @seealso{log, log10, logspace, and exp} ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> ## Created: 17 October 1994
--- a/scripts/special-matrix/hankel.m +++ b/scripts/special-matrix/hankel.m @@ -44,7 +44,7 @@ ## @end example ## @end ifinfo ## @end deftypefn -## @seealso{vander, sylvester_matrix, hilb, invhilb, toeplitz} +## @seealso{vander, sylvester_matrix, hilb, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/special-matrix/hilb.m +++ b/scripts/special-matrix/hilb.m @@ -43,7 +43,7 @@ ## @end example ## @end ifinfo ## @end deftypefn -## @seealso{hankel, vander, sylvester_matrix, invhilb, toeplitz} +## @seealso{hankel, vander, sylvester_matrix, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/special-matrix/invhilb.m +++ b/scripts/special-matrix/invhilb.m @@ -24,7 +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 -## @seealso{hankel, vander, sylvester_matrix, hilb, toeplitz} +## @seealso{hankel, vander, sylvester_matrix, hilb, and toeplitz} ## Author: jwe
--- a/scripts/special-matrix/sylvester_matrix.m +++ b/scripts/special-matrix/sylvester_matrix.m @@ -29,7 +29,7 @@ ## n = 2^k. ## @end ifinfo ## @end deftypefn -## @seealso{hankel, vander, hilb, invhilb, toeplitz} +## @seealso{hankel, vander, hilb, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/special-matrix/toeplitz.m +++ b/scripts/special-matrix/toeplitz.m @@ -53,7 +53,7 @@ ## @end example ## @end ifinfo ## @end deftypefn -## @seealso{hankel, vander, sylvester_matrix, hilb, invhib} +## @seealso{hankel, vander, sylvester_matrix, hilb, and invhib} ## Author: jwe
--- a/scripts/special-matrix/vander.m +++ b/scripts/special-matrix/vander.m @@ -47,7 +47,7 @@ ## @end example ## @end ifinfo ## @end deftypefn -## @seealso{hankel, sylvester_matrix, hilb, invhilb, toeplitz} +## @seealso{hankel, sylvester_matrix, hilb, invhilb, and toeplitz} ## Author: jwe
--- a/scripts/statistics/base/median.m +++ b/scripts/statistics/base/median.m @@ -43,7 +43,7 @@ ## If @var{x} is a matrix, compute the median value for each ## column and return them in a row vector. ## @end deftypefn -## @seealso{std, mean} +## @seealso{std and mean} ## Author: jwe
--- a/scripts/statistics/base/std.m +++ b/scripts/statistics/base/std.m @@ -39,7 +39,7 @@ ## If @var{x} is a matrix, compute the standard deviation for ## each column and return them in a row vector. ## @end deftypefn -## @seealso{mean, median} +## @seealso{mean and median} ## Author: jwe
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,9 @@ +2000-01-06 John W. Eaton <jwe@bevo.che.wisc.edu> + + * help.cc (display_help_text): Also strip out leading spaces + before Texinfo @-commands before sending doc string to makeinfo. + (display_help_text): Improve format of `See also' string. + 2000-01-05 John W. Eaton <jwe@bevo.che.wisc.edu> * help.cc (display_help_text): Pass a definition for @seealso
--- a/src/help.cc +++ b/src/help.cc @@ -611,7 +611,7 @@ cols = 72; ostrstream buf; - buf << "sed 's/^[#%]+ *//' | makeinfo" + buf << "sed -e 's/^[#%]+ *//' -e 's/^ *@/@/' | makeinfo" << " -D \"VERSION " << OCTAVE_VERSION << "\"" << " -D \"OCTAVEHOME " << OCTAVE_PREFIX << "\"" << " -D \"TARGETHOSTTYPE " << CANONICAL_HOST_TYPE << "\"" @@ -633,6 +633,8 @@ if (filter) { filter << "@macro seealso {args}\n" + << "\n" + << "@noindent\n" << "See also: \\args\\.\n" << "@end macro\n";