octave: scripts/testfun/example.m annotate

annotate scripts/testfun/example.m @ 12643:55430618bd5f

Properly warn when demo or example called on a function without demos * test.m: Return empty matrix if no demos present * demo.m, example.m: Update documentation. Warn when no demos present and return from function immediately.

author	Rik <octave@nomad.inbox5.com>
date	Mon, 02 May 2011 11:26:27 -0700
parents	6a1fe83fe129
children	e81ddf9cacd5

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 10793 diff changeset	1 ## Copyright (C) 2000-2011 Paul Kienzle
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	2 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	3 ## This file is part of Octave.
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	4 ##
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	13 ## General Public License for more details.
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	14 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6494 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	18
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	20 ## @deftypefn {Command} {} example @var{name}
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	21 ## @deftypefnx {Command} {} example @var{name} @var{n}
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	22 ## @deftypefnx {Function File} {} example ('@var{name}')
12505 6a1fe83fe129 Allow command forms of example and demo. Ben Abbott <bpabbott@mac.com> parents: 11587 diff changeset	23 ## @deftypefnx {Function File} {} example ('@var{name}', @var{n})
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	24 ## @deftypefnx {Function File} {[@var{s}, @var{idx}] =} example (@dots{})
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	25 ##
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	26 ## Display the code for example @var{n} associated with the function
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	27 ## '@var{name}', but do not run it. If @var{n} is not specified, all examples
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	28 ## are displayed.
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	29 ##
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	30 ## When called with output arguments, the examples are returned in the form of
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	31 ## a string @var{s}, with @var{idx} indicating the ending position of the
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	32 ## various examples.
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	33 ##
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	34 ## See @code{demo} for a complete explanation.
5642 2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe] jwe parents: 5589 diff changeset	35 ## @seealso{demo, test}
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	36 ## @end deftypefn
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	37
6494 76a1a953533d [project @ 2007-04-05 16:09:03 by jwe] jwe parents: 6046 diff changeset	38 function [code_r, idx_r] = example (name, n)
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	39
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	40 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5642 diff changeset	41 print_usage ();
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	42 endif
12505 6a1fe83fe129 Allow command forms of example and demo. Ben Abbott <bpabbott@mac.com> parents: 11587 diff changeset	43
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	44 if (nargin < 2)
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	45 n = 0;
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	46 elseif (ischar (n))
12505 6a1fe83fe129 Allow command forms of example and demo. Ben Abbott <bpabbott@mac.com> parents: 11587 diff changeset	47 n = str2double (n);
6a1fe83fe129 Allow command forms of example and demo. Ben Abbott <bpabbott@mac.com> parents: 11587 diff changeset	48 endif
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	49
6494 76a1a953533d [project @ 2007-04-05 16:09:03 by jwe] jwe parents: 6046 diff changeset	50 [code, idx] = test (name, "grabdemo");
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	51 if (nargout > 0)
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	52 if (n > 0)
6494 76a1a953533d [project @ 2007-04-05 16:09:03 by jwe] jwe parents: 6046 diff changeset	53 if (n <= length (idx))
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9051 diff changeset	54 code_r = code(idx(n):idx(n+1)-1);
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9051 diff changeset	55 idx_r = [1, length(code_r)+1];
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	56 else
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9051 diff changeset	57 code_r = "";
95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 9051 diff changeset	58 idx_r = [];
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	59 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	60 else
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	61 code_r = code;
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	62 idx_r = idx;
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	63 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	64 else
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	65 if (n > 0)
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	66 doidx = n;
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	67 else
6494 76a1a953533d [project @ 2007-04-05 16:09:03 by jwe] jwe parents: 6046 diff changeset	68 doidx = 1:length(idx)-1;
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	69 endif
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	70 if (isempty (idx))
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	71 warning ("no example available for %s", name);
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	72 return;
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	73 elseif (n >= length(idx))
6494 76a1a953533d [project @ 2007-04-05 16:09:03 by jwe] jwe parents: 6046 diff changeset	74 warning ("only %d examples available for %s", length(idx)-1, name);
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	75 return;
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	76 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	77
8507 cadc73247d65 style fixes John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	78 for i = 1:length (doidx)
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	79 block = code(idx(doidx(i)):idx(doidx(i)+1)-1);
6494 76a1a953533d [project @ 2007-04-05 16:09:03 by jwe] jwe parents: 6046 diff changeset	80 printf ("%s example %d:%s\n\n", name, doidx(i), block);
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	81 endfor
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	82 endif
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	83
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	84 endfunction
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	85
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	86 %!## warning: don't modify the demos without modifying the tests!
f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	87 %!demo
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	88 %! example ('example');
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	89 %!demo
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	90 %! t=0:0.01:2*pi; x = sin(t);
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	91 %! plot (t,x)
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	92
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	93 %!assert (example('example',1), "\n example ('example');");
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	94 %!test
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	95 %! [code, idx] = example ('example');
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	96 %! assert (code, ...
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	97 %! "\n example ('example');\n t=0:0.01:2*pi; x = sin(t);\n plot (t,x)")
55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	98 %! assert (idx, [1, 23, 63]);
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	99
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	100 %% Test input validation
5589 f812a0680d05 [project @ 2006-01-06 00:14:42 by jwe] jwe parents: diff changeset	101 %!error example;
12643 55430618bd5f Properly warn when demo or example called on a function without demos Rik <octave@nomad.inbox5.com> parents: 12505 diff changeset	102 %!error example('example', 3, 5)

Mercurial > octave

annotate scripts/testfun/example.m @ 12643:55430618bd5f