[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[changeset] fix @seealso references to point to existing anchors
|
From: |
Thorsten Meyer |
|
Subject: |
[changeset] fix @seealso references to point to existing anchors |
|
Date: |
Sun, 26 Oct 2008 11:29:02 +0100 |
|
User-agent: |
Mozilla-Thunderbird 2.0.0.16 (X11/20080724) |
Hi,
the attached changeset fixes the docstrings in the sources and the .txi
files in the documentation such that all @seealso references point to
existing @anchors. This changeset is meant to prepare for the
introduction of @seealso{} -> @address@hidden expansion in the
documentation build process.
regards
Thorsten Meyer
# HG changeset patch
# User Thorsten Meyer <address@hidden>
# Date 1225015861 -3600
# Node ID 28c6b480fb81a461a082467b48d2f7c517e7cb1d
# Parent b4845aebd29a3646bd19ab5778271e6278728222
fix @seealso references to point to existing anchors
diff -r b4845aebd29a -r 28c6b480fb81 doc/ChangeLog
--- a/doc/ChangeLog Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/ChangeLog Sun Oct 26 11:11:01 2008 +0100
@@ -2,6 +2,12 @@
* interpreter/munge-texi.cc: adapted to expand @seealso{}
commands to texinfo references.
+2008-10-25 Thorsten Meyer <address@hidden>
+ * system.txi, poly.txi, arith.txi, poly.txi, optim.txi, diffeq.txi,
+ sparse.txi, matrix.txi, plot.txi, io.txi, debug.txi, var.txi,
+ strings.txi:
+ added missing @DOCSTRING commands to the .txi files of the manual
+
2008-10-22 David Bateman <address@hidden>
* interprter/plot.txi: Add documentation for error bar series.
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/arith.txi
--- a/doc/interpreter/arith.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/arith.txi Sun Oct 26 11:11:01 2008 +0100
@@ -249,6 +249,7 @@
@DOCSTRING(legendre)
address@hidden
@DOCSTRING(lgamma)
@DOCSTRING(cross)
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/debug.txi
--- a/doc/interpreter/debug.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/debug.txi Sun Oct 26 11:11:01 2008 +0100
@@ -60,7 +60,7 @@
To leave the debug mode, you should simply type either @code{dbcont}
or @code{return}.
address@hidden(dbcont}
address@hidden(dbcont)
To quit debug mode and return directly to the prompt @code{dbquit}
should be used instead
@@ -167,6 +167,7 @@
@c leave dbnext undocumented
address@hidden
@DOCSTRING(dbstep)
@node Call Stack
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/diffeq.txi
--- a/doc/interpreter/diffeq.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/diffeq.txi Sun Oct 26 11:11:01 2008 +0100
@@ -147,6 +147,10 @@
and @var{dasrt}, which can be used to solve DAEs with constraints
(stopping conditions).
address@hidden(dassl)
+
address@hidden(dassl_options)
+
@DOCSTRING(dasrt)
@DOCSTRING(dasrt_options)
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/func.txi
--- a/doc/interpreter/func.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/func.txi Sun Oct 26 11:11:01 2008 +0100
@@ -335,6 +335,7 @@
@DOCSTRING(nargoutchk)
address@hidden @anchor{doc-varargout}
@node Variable-length Argument Lists
@section Variable-length Argument Lists
@cindex variable-length argument lists
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/io.txi
--- a/doc/interpreter/io.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/io.txi Sun Oct 26 11:11:01 2008 +0100
@@ -752,6 +752,8 @@
@DOCSTRING(fscanf)
address@hidden(scanf)
+
@DOCSTRING(sscanf)
Calls to @code{scanf} are superficially similar to calls to
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/matrix.txi
--- a/doc/interpreter/matrix.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/matrix.txi Sun Oct 26 11:11:01 2008 +0100
@@ -143,6 +143,7 @@
@DOCSTRING(swaprows)
address@hidden
@DOCSTRING(tril)
@DOCSTRING(vec)
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/octave-bug.1
--- a/doc/interpreter/octave-bug.1 Sun Oct 26 11:10:58 2008 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,72 +0,0 @@
-.\" Copyright (C) 2000, 2004, 2005, 2007 Dirk Eddelbuettel
-.\"
-.\" This file is part of Octave.
-.\"
-.\" Octave is free software; you can redistribute it and/or modify it
-.\" under the terms of the GNU General Public License as published by the
-.\" Free Software Foundation; either version 3 of the License, or (at
-.\" your option) any later version.
-.\"
-.\" Octave is distributed in the hope that it will be useful, but WITHOUT
-.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
-.\" for more details.
-.\"
-.\" You should have received a copy of the GNU General Public License
-.\" along with Octave; see the file COPYING. If not, see
-.\" <http://www.gnu.org/licenses/>.
-.\"
-.\" This page was contributed by Dirk Eddelbuettel <address@hidden>
-.\"
-.TH octave-bug 1 "6 March 2000" GNU
-.SH NAME
-octave-bug \- report a bug in GNU Octave
-.SH SYNOPSIS
-.B octave-bug
-.RB [\| \-s
-.IR subject \|]
-.SH DESCRIPTION
-.B octave-bug
-is a shell script to help the user compose and mail bug reports
-concerning Octave in a standard format.
-.B octave-bug
-is typically invoked by the Octave command
-.B bug_report
-which is intended to be called interactively from within Octave. This
-provides the best way to submit a bug report for Octave. It creates a
-template bug report file and starts an editor on that file. The bug report
-will be sent to the bug-octave mailing list once the editing has been
-completed (this assumes of course that your system can use email). However,
-the user could also call \fBoctave-bug\fR outside of Octave.
-.PP
-Please read the `Bugs' chapter in the Octave manual to find out how to submit
-a bug report that will enable the Octave maintainers to fix the problem. If
-you are unable to use the bug_report command, send your message to the
-bug-octave mailing list, address@hidden
-.SH OPTIONS
-.TP
-.BI -s\ subject
-Specify a subject line for the bug report. Spaces in the subject must
-be quoted.
-.SH ENVIRONMENT VARIABLES
-.B
-octave-bug
-uses the environment variables
-.BR USER,
-.BR EDITOR,
-and
-.B PAGER
-which can be used for customization.
-.SH VERSION
-This document was last revised for Octave version 2.0.16.
-.SH SEE ALSO
-.BR octave (1),
-.BR bashbug (1)
-.SH AUTHOR
-.nf
-John W. Eaton
-Department of Chemical Engineering
-University of Wisconsin-Madison
-Madison, WI 53706
-USA
-<address@hidden>
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/octave-config.1
--- a/doc/interpreter/octave-config.1 Sun Oct 26 11:10:58 2008 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,80 +0,0 @@
-.\" Copyright (C) 2003, 2004, 2005, 2006, 2007 Dirk Eddelbuettel
-.\"
-.\" This file is part of Octave.
-.\"
-.\" Octave is free software; you can redistribute it and/or modify it
-.\" under the terms of the GNU General Public License as published by the
-.\" Free Software Foundation; either version 3 of the License, or (at
-.\" your option) any later version.
-.\"
-.\" Octave is distributed in the hope that it will be useful, but WITHOUT
-.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
-.\" for more details.
-.\"
-.\" You should have received a copy of the GNU General Public License
-.\" along with Octave; see the file COPYING. If not, see
-.\" <http://www.gnu.org/licenses/>.
-.\"
-.\" This page was contributed by Dirk Eddelbuettel <address@hidden>.
-.\"
-.TH OCTAVE-CONFIG 1 "19 February 2003" "GNU Octave"
-.SH NAME
-octave-config - GNU Octave component and library information retrieval
-.SH SYNOPSIS
-.B octave-config
-.RI [ options ]
-.SH DESCRIPTION
-.PP
-.B octave-config
-is a tool to obtain directory information for
-.I .oct
-and
-.I .m
-files for
-.BR octave (1).
-.SH OPTIONS
-.B octave-config
-accepts the following options:
-.TP 8
-.B \--m-site-dir
-Display the main directory for local, or site-specific, .m script files.
-.TP 8
-.B \--oct-site-dir
-Display the main directory for local, or site-specific, .oct dynamic-link
libraries.
-.TP 8
-.B \-p|\-\-print VAR
-Print the default value of the Octave configuration variable VAR.
-Recognized variables are:
-.RS
- CANONICAL_HOST_TYPE LOCALFCNFILEDIR
- DEFAULT_PAGER LOCALFCNFILEPATH
- ARCHLIBDIR LOCALOCTFILEDIR
- BINDIR LOCALOCTFILEPATH
- DATADIR LOCALSTARTUPFILEDIR
- EXEC_PREFIX LOCALVERARCHLIBDIR
- FCNFILEDIR LOCALVERFCNFILEDIR
- FCNFILEPATH LOCALVEROCTFILEDIR
- IMAGEDIR MAN1DIR
- IMAGE_PATH MAN1EXT
- INCLUDEDIR MANDIR
- INFODIR OCTFILEDIR
- INFOFILE OCTINCLUDEDIR
- LIBDIR OCTLIBDIR
- LIBEXECDIR PREFIX
- LIBEXECDIR STARTUPFILEDIR
- LOCALARCHLIBDIR VERSION
-.RE
-.TP 8
-.B \-v|\-\-version
-Display the version number of
-.BR octave (1).
-.TP 8
-.B \-h|-?|--help
-Display a help page about
-.B octave-config
-.SH AUTHOR
-John W. Eaton <address@hidden>
-
-This manual page was contributed by Dirk Eddelbuettel <address@hidden>
-for the Debian GNU/Linux distribution but may be used by others.
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/octave.1
--- a/doc/interpreter/octave.1 Sun Oct 26 11:10:58 2008 +0100
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,78 +0,0 @@
-.\" Copyright (C) 1996, 1997, 2004, 2005, 2007 John W. Eaton
-.\"
-.\" This file is part of Octave.
-.\"
-.\" Octave is free software; you can redistribute it and/or modify it
-.\" under the terms of the GNU General Public License as published by the
-.\" Free Software Foundation; either version 3 of the License, or (at
-.\" your option) any later version.
-.\"
-.\" Octave is distributed in the hope that it will be useful, but WITHOUT
-.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
-.\" for more details.
-.\"
-.\" You should have received a copy of the GNU General Public License
-.\" along with Octave; see the file COPYING. If not, see
-.\" <http://www.gnu.org/licenses/>.
-.\"
-.TH Octave 1 "Jan 8 1996"
-.SH NAME
-octave \- A high-level interactive language for numerical computations.
-.SH SYNOPSIS
-.nf
-octave [options]
-.fi
-.SH OPTIONS
-The complete set of command-line options for octave is available by
-running the command
-.nf
-
- octave \-\-help
-
-.fi
-.SH DESCRIPTION
-Octave is a high-level language, primarily intended for numerical
-computations. It provides a convenient command line interface for
-solving linear and nonlinear problems numerically.
-.SH DOCUMENTATION
-The primary documentation for Octave is written using Texinfo, the GNU
-documentation system, which allows the same source files to be used to
-produce on-line and printed versions of the manual.
-.PP
-You can read the on-line copy of the Octave documentation by issuing
-the command
-.nf
-
- octave:13> help \-i
-
-.fi
-while running Octave interactively, by using the GNU Emacs info mode,
-or by running standalone programs like info or xinfo.
-.SH BUGS
-The best way to submit a bug report for Octave is to use the command
-.nf
-
- octave:13> bug_report
-
-.fi
-while running Octave interactively. This will create a template bug
-report file and start an editor on that file. Your
-message will be sent to the bug-octave mailing list
-once you are finished editing the template.
-.PP
-If you are unable to use the bug_report command, send your message
-to the
-.B address@hidden
-mailing list by some other means. Please read the `Bugs' chapter in
-the Octave manual to find out how to submit a bug report that will
-enable the Octave maintainers to fix the problem.
-.SH AUTHOR
-.nf
-John W. Eaton
-Department of Chemical Engineering
-University of Wisconsin-Madison
-Madison, WI 53706
-USA
-<address@hidden>
-.fi
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/oop.txi
--- a/doc/interpreter/oop.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/oop.txi Sun Oct 26 11:11:01 2008 +0100
@@ -349,6 +349,14 @@
@subsection Operator Overloading
@float Table,tab:overload_ops
+
address@hidden @anchor{doc-plus} @anchor{doc-minus} @anchor{doc-uplus}
address@hidden @anchor{doc-mtimes} @anchor{doc-mrdivide}
address@hidden @anchor{doc-mldivide} @anchor{doc-power}
address@hidden @anchor{doc-lt} @anchor{doc-le} @anchor{doc-gt}
address@hidden @anchor{doc-eq} @anchor{doc-ne} @anchor{doc-and}
address@hidden @anchor{doc-not} @anchor{doc-ctranspose} @anchor{doc-transpose}
+
@iftex
@tex
\vskip 6pt
@@ -361,13 +369,13 @@
& Operation && Method && Description &\cr
\noalign{\hrule}
& $a + b$ && plus (a, b) && Binary addition operator&\cr
-& $a - b$ && plus (a, b) && Binary subtraction operator&\cr
+& $a - b$ && minus (a, b) && Binary subtraction operator&\cr
& $+ a$ && uplus (a) && Unary addition operator&\cr
-& $- a$ && uminus (a) && Unary subtraction operator&\cr
+& $- a$ && @anchor{doc-uminus} uminus (a) && Unary subtraction operator&\cr
& $a .* b$ && times (a, b) && Element-wise multiplication operator&\cr
& $a * b$ && mtimes (a, b) && Matrix multiplication operator&\cr
& $a ./ b$ && rdivide (a, b) && Element-wise right division operator&\cr
-& $a / b$ && mrdivide (a, b) && Matrix right division operator&\cr
+& $a / b$ && mrdivide (a, b) && Matrix right division operator&\cr
& $a .\backslash b$ && ldivide (a, b) && Element-wise left division
operator&\cr
& $a \backslash b$ && mldivide (a, b) && Matrix left division operator&\cr
& $a .\hat b$ && power (a, b) && Element-wise power operator&\cr
@@ -381,7 +389,7 @@
& $a \& b$ && and (a, b) && Logical and operator&\cr
& $a | b$ && or (a, b) && Logical or operator&\cr
& $! b$ && not (a) && Logical not operator&\cr
-& $a'$ && ctranspose (a) && Complex conjugate transpose operator &\cr
+& $a'$ && ctranspose (a) && Complex conjugate transpose operator &\cr
& $a.'$ && transpose (a) && Transpose operator &\cr
& $a : b$ && colon (a, b) && Two element range operator &\cr
& $a : b : c$ && colon (a, b, c) && Three element range operator &\cr
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/optim.txi
--- a/doc/interpreter/optim.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/optim.txi Sun Oct 26 11:11:01 2008 +0100
@@ -28,7 +28,8 @@
* Linear Programming::
* Quadratic Programming::
* Nonlinear Programming::
-* Linear Least Squares::
+* Linear Least Squares::
+*
@end menu
@c @cindex linear programming
@@ -138,3 +139,5 @@
@DOCSTRING(gls)
@DOCSTRING(lsqnonneg)
+
address@hidden(optimset)
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/plot.txi
--- a/doc/interpreter/plot.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/plot.txi Sun Oct 26 11:11:01 2008 +0100
@@ -336,6 +336,8 @@
@DOCSTRING(text)
address@hidden
address@hidden
@DOCSTRING(xlabel)
@DOCSTRING(box)
@@ -632,12 +634,15 @@
@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.
+figure window, call the @code{close} function.
@DOCSTRING(clf)
+
address@hidden(cla)
@DOCSTRING(shg)
@@ -1606,7 +1611,10 @@
@DOCSTRING(refreshdata)
address@hidden
@c add the description of the linkdata function here when it is written
address@hidden remove the explicit anchor when you add the corresponding
@DOCSTRING
address@hidden command
@node Area series
@subsubsection Area series
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/poly.txi
--- a/doc/interpreter/poly.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/poly.txi Sun Oct 26 11:11:01 2008 +0100
@@ -85,6 +85,8 @@
@DOCSTRING(compan)
address@hidden(mpoles)
+
@node Products of Polynomials
@section Products of Polynomials
@@ -118,6 +120,8 @@
@DOCSTRING(polyderiv)
@DOCSTRING(polyder)
+
address@hidden(polyinteg)
@DOCSTRING(polyint)
@@ -171,3 +175,5 @@
@DOCSTRING(polyreduce)
+
+
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/sparse.txi
--- a/doc/interpreter/sparse.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/sparse.txi Sun Oct 26 11:11:01 2008 +0100
@@ -817,6 +817,8 @@
@DOCSTRING(normest)
address@hidden(onenormest)
+
@DOCSTRING(condest)
@DOCSTRING(spparms)
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/strings.txi
--- a/doc/interpreter/strings.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/strings.txi Sun Oct 26 11:11:01 2008 +0100
@@ -188,6 +188,8 @@
@DOCSTRING(strvcat)
address@hidden(cstrcat)
+
@DOCSTRING(strtrunc)
@DOCSTRING(string_fill_char)
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/system.txi
--- a/doc/interpreter/system.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/system.txi Sun Oct 26 11:11:01 2008 +0100
@@ -121,6 +121,7 @@
@DOCSTRING(is_leap_year)
address@hidden
@DOCSTRING(tic)
@DOCSTRING(pause)
@@ -142,6 +143,10 @@
@DOCSTRING(weekday)
@DOCSTRING(eomday)
+
address@hidden(eomdate)
+
address@hidden(datetick)
@node Filesystem Utilities
@section Filesystem Utilities
@@ -229,6 +234,8 @@
@DOCSTRING(unpack)
address@hidden(bzip2)
+
@node Networking Utilities
@section Networking Utilities
@@ -278,6 +285,28 @@
@DOCSTRING(dup2)
@DOCSTRING(waitpid)
+
address@hidden(WCONTINUE)
+
address@hidden(WCOREDUMP)
+
address@hidden(WEXITSTATUS)
+
address@hidden(WIFCONTINUED)
+
address@hidden(WIFSIGNALED)
+
address@hidden(WIFSTOPPED)
+
address@hidden(WIFEXITED)
+
address@hidden(WNOHANG)
+
address@hidden(WSTOPSIG)
+
address@hidden(WTERMSIG)
+
address@hidden(WUNTRACED)
@DOCSTRING(fcntl)
@@ -408,11 +437,15 @@
@DOCSTRING(isunix)
address@hidden(ismac)
+
@DOCSTRING(isieee)
@DOCSTRING(OCTAVE_HOME)
@DOCSTRING(OCTAVE_VERSION)
+
address@hidden(license)
@DOCSTRING(version)
diff -r b4845aebd29a -r 28c6b480fb81 doc/interpreter/var.txi
--- a/doc/interpreter/var.txi Sun Oct 26 11:10:58 2008 +0100
+++ b/doc/interpreter/var.txi Sun Oct 26 11:11:01 2008 +0100
@@ -183,6 +183,7 @@
@cindex persistent variables
@cindex @code{persistent} statement
@cindex variables, persistent
address@hidden
A variable that has been declared @dfn{persistent} within a function
will retain its contents in memory between subsequent calls to the
diff -r b4845aebd29a -r 28c6b480fb81 scripts/ChangeLog
--- a/scripts/ChangeLog Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/ChangeLog Sun Oct 26 11:11:01 2008 +0100
@@ -2,6 +2,22 @@
* miscellaneous/bzip2: added command (which is already referenced
in the bunzip2 command)
+2008-10-25 Thorsten Meyer <address@hidden>
+ * set/create_set.m, set/ismember.m, set/union.m,
+ set/complement.m: fixed @seealso references to deprecated
+ function intersection
+ * polynomial/polyvalm.m, polyout.m, polyint.m, polygcd.m,
+ deprecated/polyinteg.m:
+ removed "and" from @seealso string
+ * specfun/betaln.m: changed @seealso reference from deprecated
+ betai to betainc
+ * plot/plot.m, plot/xlabel.m, plot/ylabel.m, plot/zlabel.m,
+ plot/plot3.m: corrected @seealso references to ylabel and
+ zlabel.
+ * general/issymmetric.m, imagesc.m,specfun/realpow.m,
+ polynomial/polyfit.m, time/eomday.m:
+ removed @seealso reference to non-existing functions
+
2008-10-22 Ben Abbott <address@hidden>
* plot/cla.m: Fix error when no children to clear.
diff -r b4845aebd29a -r 28c6b480fb81 scripts/deprecated/polyinteg.m
--- a/scripts/deprecated/polyinteg.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/deprecated/polyinteg.m Sun Oct 26 11:11:01 2008 +0100
@@ -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 <address@hidden>
diff -r b4845aebd29a -r 28c6b480fb81 scripts/general/issymmetric.m
--- a/scripts/general/issymmetric.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/general/issymmetric.m Sun Oct 26 11:11:01 2008 +0100
@@ -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
diff -r b4845aebd29a -r 28c6b480fb81 scripts/image/imagesc.m
--- a/scripts/image/imagesc.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/image/imagesc.m Sun Oct 26 11:11:01 2008 +0100
@@ -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 <address@hidden>
diff -r b4845aebd29a -r 28c6b480fb81 scripts/plot/plot3.m
--- a/scripts/plot/plot3.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/plot/plot3.m Sun Oct 26 11:11:01 2008 +0100
@@ -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
diff -r b4845aebd29a -r 28c6b480fb81 scripts/plot/xlabel.m
--- a/scripts/plot/xlabel.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/plot/xlabel.m Sun Oct 26 11:11:01 2008 +0100
@@ -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
diff -r b4845aebd29a -r 28c6b480fb81 scripts/plot/ylabel.m
--- a/scripts/plot/ylabel.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/plot/ylabel.m Sun Oct 26 11:11:01 2008 +0100
@@ -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
diff -r b4845aebd29a -r 28c6b480fb81 scripts/plot/zlabel.m
--- a/scripts/plot/zlabel.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/plot/zlabel.m Sun Oct 26 11:11:01 2008 +0100
@@ -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
diff -r b4845aebd29a -r 28c6b480fb81 scripts/polynomial/polyfit.m
--- a/scripts/polynomial/polyfit.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/polynomial/polyfit.m Sun Oct 26 11:11:01 2008 +0100
@@ -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 <address@hidden>
diff -r b4845aebd29a -r 28c6b480fb81 scripts/polynomial/polygcd.m
--- a/scripts/polynomial/polygcd.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/polynomial/polygcd.m Sun Oct 26 11:11:01 2008 +0100
@@ -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)
diff -r b4845aebd29a -r 28c6b480fb81 scripts/polynomial/polyint.m
--- a/scripts/polynomial/polyint.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/polynomial/polyint.m Sun Oct 26 11:11:01 2008 +0100
@@ -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 <address@hidden>
diff -r b4845aebd29a -r 28c6b480fb81 scripts/polynomial/polyout.m
--- a/scripts/polynomial/polyout.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/polynomial/polyout.m Sun Oct 26 11:11:01 2008 +0100
@@ -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 <address@hidden>
diff -r b4845aebd29a -r 28c6b480fb81 scripts/polynomial/polyvalm.m
--- a/scripts/polynomial/polyvalm.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/polynomial/polyvalm.m Sun Oct 26 11:11:01 2008 +0100
@@ -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 <address@hidden>
diff -r b4845aebd29a -r 28c6b480fb81 scripts/set/complement.m
--- a/scripts/set/complement.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/set/complement.m Sun Oct 26 11:11:01 2008 +0100
@@ -28,7 +28,7 @@
## @result{} 5
## @end group
## @end example
-## @seealso{create_set, union, intersection}
+## @seealso{create_set, union, intersect}
## @end deftypefn
## Author: jwe
diff -r b4845aebd29a -r 28c6b480fb81 scripts/set/create_set.m
--- a/scripts/set/create_set.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/set/create_set.m Sun Oct 26 11:11:01 2008 +0100
@@ -40,7 +40,7 @@
## 4 2
## @end group
## @end example
-## @seealso{union, intersection, complement, unique}
+## @seealso{union, intersect, complement, unique}
## @end deftypefn
## Author: jwe
diff -r b4845aebd29a -r 28c6b480fb81 scripts/set/ismember.m
--- a/scripts/set/ismember.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/set/ismember.m Sun Oct 26 11:11:01 2008 +0100
@@ -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 <address@hidden>
diff -r b4845aebd29a -r 28c6b480fb81 scripts/set/union.m
--- a/scripts/set/union.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/set/union.m Sun Oct 26 11:11:01 2008 +0100
@@ -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
diff -r b4845aebd29a -r 28c6b480fb81 scripts/specfun/betaln.m
--- a/scripts/specfun/betaln.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/specfun/betaln.m Sun Oct 26 11:11:01 2008 +0100
@@ -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 <address@hidden>
diff -r b4845aebd29a -r 28c6b480fb81 scripts/specfun/realpow.m
--- a/scripts/specfun/realpow.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/specfun/realpow.m Sun Oct 26 11:11:01 2008 +0100
@@ -21,7 +21,7 @@
## Return the element by element power operator. This is equivalent to
## @address@hidden .^ @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)
diff -r b4845aebd29a -r 28c6b480fb81 scripts/time/eomday.m
--- a/scripts/time/eomday.m Sun Oct 26 11:10:58 2008 +0100
+++ b/scripts/time/eomday.m Sun Oct 26 11:11:01 2008 +0100
@@ -19,7 +19,7 @@
## -*- texinfo -*-
## @deftypefn {Function File} address@hidden =} 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 <address@hidden>
diff -r b4845aebd29a -r 28c6b480fb81 src/ChangeLog
--- a/src/ChangeLog Sun Oct 26 11:10:58 2008 +0100
+++ b/src/ChangeLog Sun Oct 26 11:11:01 2008 +0100
@@ -1,3 +1,21 @@
+2008-10-25 Thorsten Meyer <address@hidden>
+ * data.cc: removed "add" from @seealso string
+ * mappers.cc: replace @seealso reference to deprecated gammai
+ by gammainc
+ * DLD-FUNCTIONS/sqrtm.cc: removed reference to octave forge
+ function funm
+ * DLD-FUNCTIONS/qz.cc: removed @seealso reference to octave forge
+ function dare
+ * DLD-FUNCTIONS/rcond.cc: removed @seealso reference to mldivide
+ * debug.cc: corrected @seealso references and function name in
+ docstring of dbnext
+ * cellfun.cc: removed @seealso reference to isclass
+ * syscalls.cc: replaced WCONTINUED by WCONTINUE
+ * oct-hist.cc: fixed @seealso references to
+ history_timestamp_format_string
+ * DLD-FUNCTIONS/luinc.cc: removed reference to missing function
+ cholinc
+
2008-10-23 John W. Eaton <address@hidden>
* oct-hist.c (initialize_history): New arg, read_history_file)
diff -r b4845aebd29a -r 28c6b480fb81 src/DLD-FUNCTIONS/cellfun.cc
--- a/src/DLD-FUNCTIONS/cellfun.cc Sun Oct 26 11:10:58 2008 +0100
+++ b/src/DLD-FUNCTIONS/cellfun.cc Sun Oct 26 11:11:01 2008 +0100
@@ -124,7 +124,7 @@
@end group\n\
@end example\n\
\n\
address@hidden, islogical, isreal, length, ndims, numel, size, isclass}\n\
address@hidden, islogical, isreal, length, ndims, numel, size}\n\
@end deftypefn")
{
octave_value_list retval;
diff -r b4845aebd29a -r 28c6b480fb81 src/DLD-FUNCTIONS/luinc.cc
--- a/src/DLD-FUNCTIONS/luinc.cc Sun Oct 26 11:10:58 2008 +0100
+++ b/src/DLD-FUNCTIONS/luinc.cc Sun Oct 26 11:11:01 2008 +0100
@@ -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\
address@hidden, lu, cholinc}\n\
address@hidden, lu}\n\
@end deftypefn")
{
int nargin = args.length ();
diff -r b4845aebd29a -r 28c6b480fb81 src/DLD-FUNCTIONS/qz.cc
--- a/src/DLD-FUNCTIONS/qz.cc Sun Oct 26 11:10:58 2008 +0100
+++ b/src/DLD-FUNCTIONS/qz.cc Sun Oct 26 11:11:01 2008 +0100
@@ -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\
address@hidden, dare, eig, schur}\n\
address@hidden, eig, schur}\n\
@end deftypefn")
{
octave_value_list retval;
diff -r b4845aebd29a -r 28c6b480fb81 src/DLD-FUNCTIONS/rcond.cc
--- a/src/DLD-FUNCTIONS/rcond.cc Sun Oct 26 11:10:58 2008 +0100
+++ b/src/DLD-FUNCTIONS/rcond.cc Sun Oct 26 11:11:01 2008 +0100
@@ -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\
address@hidden, mldivide}\n\
address@hidden
@end deftypefn")
{
octave_value retval;
diff -r b4845aebd29a -r 28c6b480fb81 src/DLD-FUNCTIONS/sqrtm.cc
--- a/src/DLD-FUNCTIONS/sqrtm.cc Sun Oct 26 11:10:58 2008 +0100
+++ b/src/DLD-FUNCTIONS/sqrtm.cc Sun Oct 26 11:11:01 2008 +0100
@@ -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\
address@hidden, logm, funm}\n\
address@hidden, logm}\n\
@end deftypefn")
{
octave_value_list retval;
diff -r b4845aebd29a -r 28c6b480fb81 src/data.cc
--- a/src/data.cc Sun Oct 26 11:10:58 2008 +0100
+++ b/src/data.cc Sun Oct 26 11:11:01 2008 +0100
@@ -2487,7 +2487,7 @@
"-*- texinfo -*-\n\
@deftypefn {Built-in Function} {} columns (@var{a})\n\
Return the number of columns of @var{a}.\n\
address@hidden, numel, rows, length, isscalar, isvector, and ismatrix}\n\
address@hidden, numel, rows, length, isscalar, isvector, ismatrix}\n\
@end deftypefn")
{
octave_value retval;
diff -r b4845aebd29a -r 28c6b480fb81 src/debug.cc
--- a/src/debug.cc Sun Oct 26 11:10:58 2008 +0100
+++ b/src/debug.cc Sun Oct 26 11:11:01 2008 +0100
@@ -378,7 +378,7 @@
@end table\n\
\n\
The rline returned is the real line that the breakpoint was set at.\n\
address@hidden, dbstatus, dbnext}\n\
address@hidden, dbstatus, dbstep}\n\
@end deftypefn")
{
bp_table::intmap retval;
@@ -972,7 +972,7 @@
DEFCMD (dbnext, args, ,
"-*- texinfo -*-\n\
address@hidden {Command} {} dbquit ()\n\
address@hidden {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\
diff -r b4845aebd29a -r 28c6b480fb81 src/mappers.cc
--- a/src/mappers.cc Sun Oct 26 11:10:58 2008 +0100
+++ b/src/mappers.cc Sun Oct 26 11:11:01 2008 +0100
@@ -749,7 +749,7 @@
t=0\n\
@end example\n\
@end ifinfo\n\
address@hidden, lgamma}\n\
address@hidden, 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\
address@hidden, gammai}\n\
address@hidden, gammainc}\n\
@end deftypefn")
{
octave_value retval;
diff -r b4845aebd29a -r 28c6b480fb81 src/oct-hist.cc
--- a/src/oct-hist.cc Sun Oct 26 11:10:58 2008 +0100
+++ b/src/oct-hist.cc Sun Oct 26 11:11:01 2008 +0100
@@ -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\
address@hidden, history_timestamp_format, saving_history}\n\
address@hidden, history_timestamp_format_string, saving_history}\n\
@end deftypefn")
{
int saved_history_size = Vhistory_size;
@@ -729,7 +729,7 @@
@deftypefnx {Built-in Function} address@hidden =} 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\
address@hidden, history_size, history_timestamp_format}\n\
address@hidden, history_size, history_timestamp_format_string}\n\
@end deftypefn")
{
octave_value retval = SET_INTERNAL_VARIABLE (saving_history);
diff -r b4845aebd29a -r 28c6b480fb81 src/syscalls.cc
--- a/src/syscalls.cc Sun Oct 26 11:10:58 2008 +0100
+++ b/src/syscalls.cc Sun Oct 26 11:11:01 2008 +0100
@@ -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\
address@hidden WCONTINUED\n\
address@hidden 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\
address@hidden, WCOREDUMP, WEXITSTATUS, WIFCONTINUED, WIFSIGNALED, WIFSTOPPED,
WNOHANG, WSTOPSIG, WTERMSIG, WUNTRACED}\n\
address@hidden, WCOREDUMP, WEXITSTATUS, WIFCONTINUED, WIFSIGNALED, WIFSTOPPED,
WNOHANG, WSTOPSIG, WTERMSIG, WUNTRACED}\n\
@end deftypefn")
{
octave_value_list retval;
- [changeset] fix @seealso references to point to existing anchors,
Thorsten Meyer <=