Mercurial > hg > octave-lyh
diff scripts/testfun/fail.m @ 12632:2dbac27e0e40 stable
doc: miscellaneous touch-ups to documentation strings
* debug.txi: Correct line number for debug example.
* func.txi: Correct directory structure of functions shipped with Octave distribution.
* edit.m: Eliminate reference to editor used by bug_report.
* fzero.m: Add inline function to list of possible inputs.
* fplot.m: Add comma to break list of possible inputs.
* qqplot.m: Correct example so that it runs under current Octave distributions.
* assert.m: Add seealso reference to fail.
* fail.m: Add seealso reference to assert. Add additional calling forms of function.
* load-path.cc (addpath): Don't use @samp which created double double quotes around option.
* ov-fcn-inline.cc (vectorize): Add example usage.
* variables.cc (exist): Add seealso link to file_in_loadpath.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 25 Apr 2011 09:24:33 -0700 |
parents | c792872f8942 |
children | 756af8385e26 |
line wrap: on
line diff
--- a/scripts/testfun/fail.m +++ b/scripts/testfun/fail.m @@ -20,7 +20,8 @@ ## public domain. ## -*- texinfo -*- -## @deftypefn {Function File} {} fail (@var{code}, @var{pattern}) +## @deftypefn {Function File} {} fail (@var{code}) +## @deftypefnx {Function File} {} fail (@var{code}, @var{pattern}) ## @deftypefnx {Function File} {} fail (@var{code}, 'warning', @var{pattern}) ## ## Return true if @var{code} fails with an error message matching @@ -45,7 +46,7 @@ ## Called with three arguments, the behavior is similar to ## @code{fail(@var{code}, @var{pattern})}, but produces an error if no ## warning is given during code execution or if the code fails. -## +## @seealso{assert} ## @end deftypefn ## Author: Paul Kienzle <pkienzle@users.sf.net>