Mercurial > octave

comparison scripts/testfun/test.m @ 9051:1bf0ce0930be

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammar check TexInfo in all .m files Cleanup documentation sources to follow a few consistent rules. Spellcheck was NOT done. (but will be in another changeset)
author Rik <rdrider0-list@yahoo.com>
date Fri, 27 Mar 2009 22:31:03 -0700
parents eb63fbe60fab
children 929e53107f09
comparison
equal deleted inserted replaced
9044:656ad518f385 9051:1bf0ce0930be
24 ## @deftypefnx {Function File} {@var{success} =} test (@dots{}) 24 ## @deftypefnx {Function File} {@var{success} =} test (@dots{})
25 ## @deftypefnx {Function File} {[@var{n}, @var{max}] =} test (@dots{}) 25 ## @deftypefnx {Function File} {[@var{n}, @var{max}] =} test (@dots{})
26 ## @deftypefnx {Function File} {[@var{code}, @var{idx}] =} test ('@var{name}','grabdemo') 26 ## @deftypefnx {Function File} {[@var{code}, @var{idx}] =} test ('@var{name}','grabdemo')
27 ## 27 ##
28 ## Perform tests from the first file in the loadpath matching @var{name}. 28 ## Perform tests from the first file in the loadpath matching @var{name}.
29 ## @code{test} can be called as a command or as a function. Called with 29 ## @code{test} can be called as a command or as a function. Called with
30 ## a single argument @var{name}, the tests are run interactively and stop 30 ## a single argument @var{name}, the tests are run interactively and stop
31 ## after the first error is encountered. 31 ## after the first error is encountered.
32 ## 32 ##
33 ## With a second argument the tests which are performed and the amount of 33 ## With a second argument the tests which are performed and the amount of
34 ## output is selected. 34 ## output is selected.
43 ## 43 ##
44 ## @item 'verbose' 44 ## @item 'verbose'
45 ## Do tests which require user interaction. 45 ## Do tests which require user interaction.
46 ## @end table 46 ## @end table
47 ## 47 ##
48 ## The argument @var{fid} can be used to allow batch processing. Errors 48 ## The argument @var{fid} can be used to allow batch processing. Errors
49 ## can be written to the already open file defined by @var{fid}, and 49 ## can be written to the already open file defined by @var{fid}, and
50 ## hopefully when Octave crashes this file will tell you what was happening 50 ## hopefully when Octave crashes this file will tell you what was happening
51 ## when it did. You can use @code{stdout} if you want to see the results as 51 ## when it did. You can use @code{stdout} if you want to see the results as
52 ## they happen. You can also give a file name rather than an @var{fid}, in 52 ## they happen. You can also give a file name rather than an @var{fid}, in
53 ## which case the contents of the file will be replaced with the log from 53 ## which case the contents of the file will be replaced with the log from
54 ## the current test. 54 ## the current test.
55 ## 55 ##
56 ## Called with a single output argument @var{success}, @code{test} returns 56 ## Called with a single output argument @var{success}, @code{test} returns
57 ## true if all of the tests were successful. Called with two output arguments 57 ## true if all of the tests were successful. Called with two output arguments
58 ## @var{n} and @var{max}, the number of successful tests and the total number 58 ## @var{n} and @var{max}, the number of successful tests and the total number
59 ## of tests in the file @var{name} are returned. 59 ## of tests in the file @var{name} are returned.
60 ## 60 ##
61 ## If the second argument is the string 'grabdemo', the contents of the demo 61 ## If the second argument is the string 'grabdemo', the contents of the demo
62 ## blocks are extracted but not executed. Code for all code blocks is 62 ## blocks are extracted but not executed. Code for all code blocks is
63 ## concatenated and returned as @var{code} with @var{idx} being a vector of 63 ## concatenated and returned as @var{code} with @var{idx} being a vector of
64 ## positions of the ends of the demo blocks. 64 ## positions of the ends of the demo blocks.
65 ## 65 ##
66 ## If the second argument is 'explain', then @var{name} is ignored and an 66 ## If the second argument is 'explain', then @var{name} is ignored and an
67 ## explanation of the line markers used is written to the file @var{fid}. 67 ## explanation of the line markers used is written to the file @var{fid}.