Mercurial > hg > octave-lojdl
changeset 8286:6f2d95255911
fix @seealso references to point to existing anchors
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,13 @@ +2008-10-29 Thorsten Meyer <tmeyier@gmx.de> + + * interpreter/system.txi, interpreter/poly.txi, + interpreter/arith.txi, interpreter/poly.txi, + interpreter/optim.txi, interpreter/diffeq.txi, + interpreter/sparse.txi, interpreter/matrix.txi, + interpreter/plot.txi, interpreter/io.txi, interpreter/debug.txi, + interpreter/var.txi, interpreter/strings.txi: + Add missing @DOCSTRING commands. + 2008-10-22 David Bateman <dbateman@free.fr> * interprter/plot.txi: Add documentation for error bar series.
--- a/doc/interpreter/arith.txi +++ b/doc/interpreter/arith.txi @@ -249,6 +249,7 @@ @DOCSTRING(legendre) +@anchor{doc-gammaln} @DOCSTRING(lgamma) @DOCSTRING(cross)
--- a/doc/interpreter/debug.txi +++ b/doc/interpreter/debug.txi @@ -167,6 +167,7 @@ @c leave dbnext undocumented +@anchor{doc-dbnext} @DOCSTRING(dbstep) @node Call Stack
--- a/doc/interpreter/diffeq.txi +++ b/doc/interpreter/diffeq.txi @@ -147,6 +147,10 @@ and @var{dasrt}, which can be used to solve DAEs with constraints (stopping conditions). +@DOCSTRING(dassl) + +@DOCSTRING(dassl_options) + @DOCSTRING(dasrt) @DOCSTRING(dasrt_options)
--- a/doc/interpreter/func.txi +++ b/doc/interpreter/func.txi @@ -335,6 +335,7 @@ @DOCSTRING(nargoutchk) +@anchor{doc-varargin} @anchor{doc-varargout} @node Variable-length Argument Lists @section Variable-length Argument Lists @cindex variable-length argument lists
--- a/doc/interpreter/io.txi +++ b/doc/interpreter/io.txi @@ -752,6 +752,8 @@ @DOCSTRING(fscanf) +@DOCSTRING(scanf) + @DOCSTRING(sscanf) Calls to @code{scanf} are superficially similar to calls to
--- a/doc/interpreter/matrix.txi +++ b/doc/interpreter/matrix.txi @@ -143,6 +143,7 @@ @DOCSTRING(swaprows) +@anchor{doc-triu} @DOCSTRING(tril) @DOCSTRING(vec)
--- a/doc/interpreter/oop.txi +++ b/doc/interpreter/oop.txi @@ -349,6 +349,14 @@ @subsection Operator Overloading @float Table,tab:overload_ops + +@anchor{doc-rdivide} @anchor{doc-plus} @anchor{doc-minus} @anchor{doc-uminus} +@anchor{doc-uplus} @anchor{doc-times} @anchor{doc-mtimes} @anchor{doc-mrdivide} +@anchor{doc-ldivide} @anchor{doc-mldivide} @anchor{doc-power} +@anchor{doc-mpower} @anchor{doc-lt} @anchor{doc-le} @anchor{doc-gt} +@anchor{doc-ge} @anchor{doc-eq} @anchor{doc-ne} @anchor{doc-and} +@anchor{doc-or} @anchor{doc-not} @anchor{doc-ctranspose} @anchor{doc-transpose} + @iftex @tex \vskip 6pt
--- a/doc/interpreter/optim.txi +++ b/doc/interpreter/optim.txi @@ -138,3 +138,5 @@ @DOCSTRING(gls) @DOCSTRING(lsqnonneg) + +@DOCSTRING(optimset)
--- a/doc/interpreter/plot.txi +++ b/doc/interpreter/plot.txi @@ -336,6 +336,8 @@ @DOCSTRING(text) +@anchor{doc-ylabel} +@anchor{doc-zlabel} @DOCSTRING(xlabel) @DOCSTRING(box) @@ -632,13 +634,16 @@ @DOCSTRING(ishold) -To clear the current figure, call the @code{clf} function. To bring it +To clear the current figure, call the @code{clf} function. To clear the +current axis, call the @code{cla} function. To bring the current fingure to the top of the window stack, call the @code{shg} function. To delete a graphics object, call @code{delete} on its index. To close the figure window, call the @code{close} function. @DOCSTRING(clf) +@DOCSTRING(cla) + @DOCSTRING(shg) @DOCSTRING(delete) @@ -1606,7 +1611,10 @@ @DOCSTRING(refreshdata) +@anchor{doc-linkdata} @c add the description of the linkdata function here when it is written +@c remove the explicit anchor when you add the corresponding @DOCSTRING +@c command @node Area series @subsubsection Area series
--- a/doc/interpreter/poly.txi +++ b/doc/interpreter/poly.txi @@ -85,6 +85,8 @@ @DOCSTRING(compan) +@DOCSTRING(mpoles) + @node Products of Polynomials @section Products of Polynomials @@ -119,6 +121,8 @@ @DOCSTRING(polyder) +@DOCSTRING(polyinteg) + @DOCSTRING(polyint) @node Polynomial Interpolation @@ -171,3 +175,5 @@ @DOCSTRING(polyreduce) + +
--- a/doc/interpreter/sparse.txi +++ b/doc/interpreter/sparse.txi @@ -817,6 +817,8 @@ @DOCSTRING(normest) +@DOCSTRING(onenormest) + @DOCSTRING(condest) @DOCSTRING(spparms)
--- a/doc/interpreter/strings.txi +++ b/doc/interpreter/strings.txi @@ -188,6 +188,8 @@ @DOCSTRING(strvcat) +@DOCSTRING(cstrcat) + @DOCSTRING(strtrunc) @DOCSTRING(string_fill_char)
--- a/doc/interpreter/system.txi +++ b/doc/interpreter/system.txi @@ -121,6 +121,7 @@ @DOCSTRING(is_leap_year) +@anchor{doc-toc} @DOCSTRING(tic) @DOCSTRING(pause) @@ -143,6 +144,10 @@ @DOCSTRING(eomday) +@DOCSTRING(eomdate) + +@DOCSTRING(datetick) + @node Filesystem Utilities @section Filesystem Utilities @@ -229,6 +234,8 @@ @DOCSTRING(unpack) +@DOCSTRING(bzip2) + @node Networking Utilities @section Networking Utilities @@ -279,6 +286,28 @@ @DOCSTRING(waitpid) +@DOCSTRING(WCONTINUE) + +@DOCSTRING(WCOREDUMP) + +@DOCSTRING(WEXITSTATUS) + +@DOCSTRING(WIFCONTINUED) + +@DOCSTRING(WIFSIGNALED) + +@DOCSTRING(WIFSTOPPED) + +@DOCSTRING(WIFEXITED) + +@DOCSTRING(WNOHANG) + +@DOCSTRING(WSTOPSIG) + +@DOCSTRING(WTERMSIG) + +@DOCSTRING(WUNTRACED) + @DOCSTRING(fcntl) @DOCSTRING(kill) @@ -408,12 +437,16 @@ @DOCSTRING(isunix) +@DOCSTRING(ismac) + @DOCSTRING(isieee) @DOCSTRING(OCTAVE_HOME) @DOCSTRING(OCTAVE_VERSION) +@DOCSTRING(license) + @DOCSTRING(version) @DOCSTRING(ver)
--- a/doc/interpreter/var.txi +++ b/doc/interpreter/var.txi @@ -183,6 +183,7 @@ @cindex persistent variables @cindex @code{persistent} statement @cindex variables, persistent +@anchor{doc-persistent} A variable that has been declared @dfn{persistent} within a function will retain its contents in memory between subsequent calls to the
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,18 @@ +2008-10-29 Thorsten Meyer <thorsten.meyier@gmx.de> + + * set/create_set.m, set/ismember.m, set/union.m, set/complement.m: + Fix @seealso references to deprecated function intersection. + * polynomial/polyvalm.m, polynomial/polyout.m, + polynomial/polyint.m, polynomial/polygcd.m, + deprecated/polyinteg.m: Remove "and" from @seealso string. + * specfun/betaln.m: Change @seealso reference from deprecated + betai to betainc. + * plot/plot.m, plot/xlabel.m, plot/ylabel.m, plot/zlabel.m, + plot/plot3.m: Fix @seealso references to ylabel and zlabel. + * general/issymmetric.m, image/imagesc.m, specfun/realpow.m, + polynomial/polyfit.m, time/eomday.m: Remove @seealso references to + non-existent functions. + 2008-10-29 John W. Eaton <jwe@octave.org> * plot/cla.m: In test, set visible off when creating figure.
--- a/scripts/deprecated/polyinteg.m +++ b/scripts/deprecated/polyinteg.m @@ -22,8 +22,8 @@ ## coefficients are represented by the vector @var{c}. ## ## The constant of integration is set to zero. -## @seealso{poly, polyderiv, polyreduce, roots, conv, deconv, residue, -## filter, polyval, and polyvalm} +## @seealso{polyint, poly, polyderiv, polyreduce, roots, conv, deconv, residue, +## filter, polyval, polyvalm} ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/general/issymmetric.m +++ b/scripts/general/issymmetric.m @@ -24,7 +24,7 @@ ## @var{tol} is omitted, use a tolerance equal to the machine precision. ## Matrix @var{x} is considered symmetric if ## @code{norm (@var{x} - @var{x}.', inf) / norm (@var{x}, inf) < @var{tol}}. -## @seealso{size, rows, columns, length, ishermitian, ismatrix, isscalar, +## @seealso{size, rows, columns, length, ismatrix, isscalar, ## issquare, isvector} ## @end deftypefn
--- a/scripts/image/imagesc.m +++ b/scripts/image/imagesc.m @@ -33,7 +33,7 @@ ## values for the respective axes, or as values for each row and column ## of the matrix @var{a}. ## -## @seealso{image, imshow, clim, caxis} +## @seealso{image, imshow, caxis} ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/plot/plot3.m +++ b/scripts/plot/plot3.m @@ -79,7 +79,7 @@ ## plot3 (z, exp(2i*pi*z), ";complex sinusoid;"); ## @end group ## @end example -## @seealso{plot} +## @seealso{plot, xlabel, ylabel, zlabel, title, print} ## @end deftypefn ## Author: Paul Kienzle
--- a/scripts/plot/xlabel.m +++ b/scripts/plot/xlabel.m @@ -25,7 +25,7 @@ ## Specify x, y, and z axis labels for the current figure. If @var{h} is ## specified then label the axis defined by @var{h}. ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, -## bar, stairs, ylabel, title} +## bar, stairs, title} ## @end deftypefn ## PKG_ADD: mark_as_command xlabel
--- a/scripts/plot/ylabel.m +++ b/scripts/plot/ylabel.m @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} ylabel (@var{string}) ## @deftypefnx {Function File} {} ylabel (@var{h}, @var{string}) -## See xlabel. +## @seealso{xlabel}. ## @end deftypefn ## PKG_ADD: mark_as_command ylabel
--- a/scripts/plot/zlabel.m +++ b/scripts/plot/zlabel.m @@ -20,7 +20,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {} zlabel (@var{string}) ## @deftypefnx {Function File} {} zlabel (@var{h}, @var{string}) -## See xlabel. +## @seealso{xlabel}. ## @end deftypefn ## PKG_ADD: mark_as_command zlabel
--- a/scripts/polynomial/polyfit.m +++ b/scripts/polynomial/polyfit.m @@ -48,7 +48,7 @@ ## Where @var{mu}(1) = mean (@var{x}), and @var{mu}(2) = std (@var{x}). ## This linear transformation of @var{x} improves the numerical ## stability of the fit. -## @seealso{polyval, polyconf, residue} +## @seealso{polyval, residue} ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
--- a/scripts/polynomial/polygcd.m +++ b/scripts/polynomial/polygcd.m @@ -38,7 +38,7 @@ ## @result{} [ 0, 0, 0 ] ## @end example ## @seealso{poly, polyinteg, polyderiv, polyreduce, roots, conv, deconv, -## residue, filter, polyval, and polyvalm} +## residue, filter, polyval, polyvalm} ## @end deftypefn function x = polygcd (b, a, tol)
--- a/scripts/polynomial/polyint.m +++ b/scripts/polynomial/polyint.m @@ -22,7 +22,7 @@ ## coefficients are represented by the vector @var{c}. The variable ## @var{k} is the constant of integration, which by default is set to zero. ## @seealso{poly, polyderiv, polyreduce, roots, conv, deconv, residue, -## filter, polyval, and polyvalm} +## filter, polyval, polyvalm} ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/polynomial/polyout.m +++ b/scripts/polynomial/polyout.m @@ -34,7 +34,7 @@ ## @var{nargout} is zero). ## @var{x} defaults to the string @code{"s"}. ## @seealso{polyval, polyvalm, poly, roots, conv, deconv, residue, -## filter, polyderiv, and polyinteg} +## filter, polyderiv, polyinteg} ## @end deftypefn ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
--- a/scripts/polynomial/polyvalm.m +++ b/scripts/polynomial/polyvalm.m @@ -27,7 +27,7 @@ ## ## The argument @var{x} must be a square matrix. ## @seealso{polyval, poly, roots, conv, deconv, residue, filter, -## polyderiv, and polyinteg} +## polyderiv, polyinteg} ## @end deftypefn ## Author: Tony Richardson <arichard@stark.cc.oh.us>
--- a/scripts/set/complement.m +++ b/scripts/set/complement.m @@ -28,7 +28,7 @@ ## @result{} 5 ## @end group ## @end example -## @seealso{create_set, union, intersection} +## @seealso{create_set, union, intersect} ## @end deftypefn ## Author: jwe
--- a/scripts/set/create_set.m +++ b/scripts/set/create_set.m @@ -40,7 +40,7 @@ ## 4 2 ## @end group ## @end example -## @seealso{union, intersection, complement, unique} +## @seealso{union, intersect, complement, unique} ## @end deftypefn ## Author: jwe
--- a/scripts/set/ismember.m +++ b/scripts/set/ismember.m @@ -60,7 +60,7 @@ ## @end group ## @end example ## -## @seealso{unique, union, intersection, setxor, setdiff} +## @seealso{unique, union, intersect, setxor, setdiff} ## @end deftypefn ## Author: Paul Kienzle <pkienzle@users.sf.net>
--- a/scripts/set/union.m +++ b/scripts/set/union.m @@ -48,7 +48,7 @@ ## Return index vectors @var{ia} and @var{ib} such that @code{a==c(ia)} and ## @code{b==c(ib)}. ## -## @seealso{create_set, intersection, complement} +## @seealso{create_set, intersect, complement} ## @end deftypefn ## Author: jwe
--- a/scripts/specfun/betaln.m +++ b/scripts/specfun/betaln.m @@ -32,7 +32,7 @@ ## betaln (a, b) = gammaln (a) + gammaln (b) - gammaln (a + b) ## @end example ## @end ifinfo -## @seealso{beta, betai, gammaln} +## @seealso{beta, betainc, gammaln} ## @end deftypefn ## Author: Nicol N. Schraudolph <nic@idsia.ch>
--- a/scripts/specfun/realpow.m +++ b/scripts/specfun/realpow.m @@ -21,7 +21,7 @@ ## Return the element by element power operator. This is equivalent to ## @code{@var{x} .^ @var{y}}, except that if the return value ## is complex @code{realpow} produces an error. -## @seealso{pow, reallog, realsqrt} +## @seealso{reallog, realsqrt} ## @end deftypefn function z = realpow (x, y)
--- a/scripts/time/eomday.m +++ b/scripts/time/eomday.m @@ -19,7 +19,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {@var{e} =} eomday (@var{y}, @var{m}) ## Return the last day of the month @var{m} for the year @var{y}. -## @seealso{datenum, datevec, weekday, eomdate} +## @seealso{datenum, datevec, weekday} ## @end deftypefn ## Author: pkienzle <pkienzle@users.sf.net>
--- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,24 @@ +2008-10-29 Thorsten Meyer <thorsten.meyier@gmx.de> + + * data.cc (Fcolumns): Remove "and" from @seealso string. + * mappers.cc (Fgamma, Flgamma): Replace @seealso reference to + deprecated gammai by gammainc. + * DLD-FUNCTIONS/sqrtm.cc (Fsqrtm): Remove reference to Octave + Forge function funm. + * DLD-FUNCTIONS/qz.cc (Fqz): removed @seealso reference to Octave + Forge function dare. + * DLD-FUNCTIONS/rcond.cc (Frcond): removed @seealso reference to + mldivide. + * debug.cc (Fdbstop): Fix @seealso references and function name in + docstring of dbnext. + * DLD-FUNCTIONS/cellfun.cc (Fcellfun): Remove @seealso reference + to isclass. + * syscalls.cc (Fwaitpid): Replace WCONTINUED by WCONTINUE. + * oct-hist.cc (Fhistory_size, Fsaving_history): Fix @seealso + references to history_timestamp_format_string. + * DLD-FUNCTIONS/luinc.cc (Fluinc): Remove reference to missing + function cholinc. + 2008-10-29 Jaroslav Hajek <highegg@gmail.com> * DLD-FUNCTIONS/qr.cc (Fcholinsert, Fcholdelete, Fcholshift): Fix
--- a/src/DLD-FUNCTIONS/cellfun.cc +++ b/src/DLD-FUNCTIONS/cellfun.cc @@ -124,7 +124,7 @@ @end group\n\ @end example\n\ \n\ -@seealso{isempty, islogical, isreal, length, ndims, numel, size, isclass}\n\ +@seealso{isempty, islogical, isreal, length, ndims, numel, size}\n\ @end deftypefn") { octave_value_list retval;
--- a/src/DLD-FUNCTIONS/luinc.cc +++ b/src/DLD-FUNCTIONS/luinc.cc @@ -93,7 +93,7 @@ \n\ Given the string argument 'vector', @dfn{luinc} returns the values of @var{p}\n\ @var{q} as vector values.\n\ -@seealso{sparse, lu, cholinc}\n\ +@seealso{sparse, lu}\n\ @end deftypefn") { int nargin = args.length ();
--- a/src/DLD-FUNCTIONS/qz.cc +++ b/src/DLD-FUNCTIONS/qz.cc @@ -280,7 +280,7 @@ Note: qz performs permutation balancing, but not scaling (see balance).\n\ Order of output arguments was selected for compatibility with MATLAB\n\ \n\ -@seealso{balance, dare, eig, schur}\n\ +@seealso{balance, eig, schur}\n\ @end deftypefn") { octave_value_list retval;
--- a/src/DLD-FUNCTIONS/rcond.cc +++ b/src/DLD-FUNCTIONS/rcond.cc @@ -40,7 +40,7 @@ The matrix @var{a} must not be sparse. If the matrix is sparse then\n\ @code{condest (@var{a})} or @code{rcond (full (@var{a}))} should be used\n\ instead.\n\ -@seealso{inv, mldivide}\n\ +@seealso{inv}\n\ @end deftypefn") { octave_value retval;
--- a/src/DLD-FUNCTIONS/sqrtm.cc +++ b/src/DLD-FUNCTIONS/sqrtm.cc @@ -178,7 +178,7 @@ Ref: Nicholas J. Higham. A new sqrtm for MATLAB. Numerical Analysis\n\ Report No. 336, Manchester Centre for Computational Mathematics,\n\ Manchester, England, January 1999.\n\ -@seealso{expm, logm, funm}\n\ +@seealso{expm, logm}\n\ @end deftypefn") { octave_value_list retval;
--- a/src/data.cc +++ b/src/data.cc @@ -2487,7 +2487,7 @@ "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {} columns (@var{a})\n\ Return the number of columns of @var{a}.\n\ -@seealso{size, numel, rows, length, isscalar, isvector, and ismatrix}\n\ +@seealso{size, numel, rows, length, isscalar, isvector, ismatrix}\n\ @end deftypefn") { octave_value retval;
--- a/src/debug.cc +++ b/src/debug.cc @@ -378,7 +378,7 @@ @end table\n\ \n\ The rline returned is the real line that the breakpoint was set at.\n\ -@seealso{dbclear, dbstatus, dbnext}\n\ +@seealso{dbclear, dbstatus, dbstep}\n\ @end deftypefn") { bp_table::intmap retval; @@ -972,7 +972,7 @@ DEFCMD (dbnext, args, , "-*- texinfo -*-\n\ -@deftypefn {Command} {} dbquit ()\n\ +@deftypefn {Command} {} dbnext ()\n\ In debugging mode, execute the next line of code without stepping in to\n\ functions. This is synonymous with @code{dbstep}.\n\ @seealso{dbstep, dbcont, dbquit}\n\
--- a/src/mappers.cc +++ b/src/mappers.cc @@ -749,7 +749,7 @@ t=0\n\ @end example\n\ @end ifinfo\n\ -@seealso{gammai, lgamma}\n\ +@seealso{gammainc, lgamma}\n\ @end deftypefn") { octave_value retval; @@ -1125,7 +1125,7 @@ @deftypefn {Mapping Function} {} lgamma (@var{x})\n\ @deftypefnx {Mapping Function} {} gammaln (@var{x})\n\ Return the natural logarithm of the gamma function of @var{x}.\n\ -@seealso{gamma, gammai}\n\ +@seealso{gamma, gammainc}\n\ @end deftypefn") { octave_value retval;
--- a/src/oct-hist.cc +++ b/src/oct-hist.cc @@ -670,7 +670,7 @@ Query or set the internal variable that specifies how many entries\n\ to store in the history file. The default value is @code{1024},\n\ but may be overridden by the environment variable @code{OCTAVE_HISTSIZE}.\n\ -@seealso{history_file, history_timestamp_format, saving_history}\n\ +@seealso{history_file, history_timestamp_format_string, saving_history}\n\ @end deftypefn") { int saved_history_size = Vhistory_size; @@ -729,7 +729,7 @@ @deftypefnx {Built-in Function} {@var{old_val} =} saving_history (@var{new_val})\n\ Query or set the internal variable that controls whether commands entered\n\ on the command line are saved in the history file.\n\ -@seealso{history_file, history_size, history_timestamp_format}\n\ +@seealso{history_file, history_size, history_timestamp_format_string}\n\ @end deftypefn") { octave_value retval = SET_INTERNAL_VARIABLE (saving_history);
--- a/src/syscalls.cc +++ b/src/syscalls.cc @@ -1284,7 +1284,7 @@ Report the status of any child processes that are stopped, and whose\n\ status has not yet been reported since they stopped.\n\ \n\ -@item WCONTINUED\n\ +@item WCONTINUE\n\ Return if a stopped child has been resumed by delivery of @code{SIGCONT}.\n\ This value may not be meaningful on all systems.\n\ @end table\n\ @@ -1294,7 +1294,7 @@ be less than zero and @var{msg} will contain a system-dependent error\n\ message. The value of @var{status} contains additional system-dependent\n\ information about the subprocess that exited.\n\ -@seealso{WCONTINUED, WCOREDUMP, WEXITSTATUS, WIFCONTINUED, WIFSIGNALED, WIFSTOPPED, WNOHANG, WSTOPSIG, WTERMSIG, WUNTRACED}\n\ +@seealso{WCONTINUE, WCOREDUMP, WEXITSTATUS, WIFCONTINUED, WIFSIGNALED, WIFSTOPPED, WNOHANG, WSTOPSIG, WTERMSIG, WUNTRACED}\n\ @end deftypefn") { octave_value_list retval;