Mercurial > hg > octave-lyh
comparison scripts/optimization/fzero.m @ 17101:e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Correctly use @xref, @pxref, @ref macros in documentation.
* doc/interpreter/arith.txi, doc/interpreter/basics.txi,
doc/interpreter/container.txi, doc/interpreter/debug.txi,
doc/interpreter/diagperm.txi, doc/interpreter/eval.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/intro.txi, doc/interpreter/java.txi,
doc/interpreter/matrix.txi, doc/interpreter/munge-texi.pl,
doc/interpreter/numbers.txi, doc/interpreter/package.txi,
doc/interpreter/plot.txi, doc/interpreter/sparse.txi,
doc/interpreter/stats.txi, doc/interpreter/strings.txi,
doc/interpreter/system.txi, doc/interpreter/var.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/error.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/regexp.cc,
scripts/general/accumarray.m, scripts/general/structfun.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/setfield.m,
scripts/miscellaneous/warning_ids.m, scripts/optimization/fminbnd.m,
scripts/optimization/fzero.m, scripts/optimization/lsqnonneg.m:
Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Correctly use @xref, @pxref, @ref macros in documentation.
* scripts/plot/line.m: Remove extra ')' in @deftypefn.
* libgui/src/qtinfo/parser.cc(find_ref): Change doc anchor search pattern to
XREF.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 27 Jul 2013 10:49:21 -0700 |
parents | 7eff3032d144 |
children | c3c1ebfaa7dc |
comparison
equal
deleted
inserted
replaced
17100:33037eddecd2 | 17101:e7a059a9a644 |
---|---|
40 ## is not successful, the function fails. | 40 ## is not successful, the function fails. |
41 ## @var{options} is a structure specifying additional options. | 41 ## @var{options} is a structure specifying additional options. |
42 ## Currently, @code{fzero} | 42 ## Currently, @code{fzero} |
43 ## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"}, | 43 ## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"}, |
44 ## @code{"TolX"}, @code{"MaxIter"}, @code{"MaxFunEvals"}. | 44 ## @code{"TolX"}, @code{"MaxIter"}, @code{"MaxFunEvals"}. |
45 ## For a description of these options, see @ref{docXoptimset,,optimset}. | 45 ## For a description of these options, see @ref{XREFoptimset,,optimset}. |
46 ## | 46 ## |
47 ## On exit, the function returns @var{x}, the approximate zero point | 47 ## On exit, the function returns @var{x}, the approximate zero point |
48 ## and @var{fval}, the function value thereof. | 48 ## and @var{fval}, the function value thereof. |
49 ## @var{info} is an exit flag that can have these values: | 49 ## @var{info} is an exit flag that can have these values: |
50 ## | 50 ## |