annotate scripts/plot/__plt__.m @ 8812:7d48766c21a5

use consistent format for doc strings of internal functions
author John W. Eaton <jwe@octave.org>
date Thu, 19 Feb 2009 02:16:34 -0500
parents a1dbe9d80eee
children eb63fbe60fab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 2000, 2002, 2004,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## 2005, 2006, 2007 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
7 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2303
diff changeset
16 ## 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: 6895
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
18 ## <http://www.gnu.org/licenses/>.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
19
8812
7d48766c21a5 use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
20 ## -*- texinfo -*-
7d48766c21a5 use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
21 ## @deftypefn {Function File} {} __plt__ (@var{caller}, @var{h}, @var{varargin})
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6459
diff changeset
22 ## Undocumented internal function.
8812
7d48766c21a5 use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
23 ## @end deftypefn
3402
9610d364e444 [project @ 2000-01-05 04:36:38 by jwe]
jwe
parents: 3178
diff changeset
24
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
25 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
26
6302
a5cd8b77e892 [project @ 2007-02-13 08:08:33 by jwe]
jwe
parents: 6264
diff changeset
27 function retval = __plt__ (caller, h, varargin)
5406
c49aec8a9080 [project @ 2005-07-08 15:25:43 by jwe]
jwe
parents: 5395
diff changeset
28
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
29 nargs = nargin - 2;
6146
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6004
diff changeset
30
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
31 if (nargs > 0)
934
be867ddbe4aa [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents: 904
diff changeset
32
5116
67320fb4ae5c [project @ 2005-01-25 03:57:01 by jwe]
jwe
parents: 5115
diff changeset
33 k = 1;
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
34
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
35 x_set = false;
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
36 y_set = false;
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
37 property_set = false;
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
38 properties = {};
934
be867ddbe4aa [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents: 904
diff changeset
39
5116
67320fb4ae5c [project @ 2005-01-25 03:57:01 by jwe]
jwe
parents: 5115
diff changeset
40 ## Gather arguments, decode format, gather plot strings, and plot lines.
934
be867ddbe4aa [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents: 904
diff changeset
41
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6302
diff changeset
42 retval = [];
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6302
diff changeset
43
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
44 while (nargs > 0 || x_set)
5115
57372235194b [project @ 2005-01-24 18:38:45 by jwe]
jwe
parents: 4717
diff changeset
45
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
46 if (nargs == 0)
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
47 ## Force the last plot when input variables run out.
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
48 next_cell = {};
6146
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6004
diff changeset
49 next_arg = {""};
5118
ecbb290ba9ff [project @ 2005-01-25 22:10:26 by jwe]
jwe
parents: 5117
diff changeset
50 else
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
51 next_cell = varargin(k);
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
52 next_arg = varargin{k++};
5116
67320fb4ae5c [project @ 2005-01-25 03:57:01 by jwe]
jwe
parents: 5115
diff changeset
53 endif
934
be867ddbe4aa [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents: 904
diff changeset
54
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
55 nargs--;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6172
diff changeset
56
6146
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6004
diff changeset
57 if (ischar (next_arg) || iscellstr (next_arg))
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
58 if (x_set)
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
59 [options, valid] = __pltopt__ (caller, next_arg, false);
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
60 if (! valid)
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
61 if (nargs == 0)
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
62 error ("%s: properties must appear followed by a value", caller);
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
63 endif
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
64 properties = [properties, [next_cell, varargin(k++)]];
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
65 nargs--;
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
66 continue;
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
67 else
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
68 while (nargs > 0 && ischar (varargin{k}))
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
69 if (nargs < 2)
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
70 error ("%s: properties must appear followed by a value",
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
71 caller);
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
72 endif
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
73 properties = [properties, varargin(k:k+1)];
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
74 k += 2;
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
75 nargs -= 2;
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
76 endwhile
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
77 endif
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
78 if (y_set)
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
79 tmp = __plt2__ (h, x, y, options, properties);
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
80 properties = {};
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6302
diff changeset
81 retval = [retval; tmp];
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
82 else
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
83 tmp = __plt1__ (h, x, options, properties);
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
84 properties = {};
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6302
diff changeset
85 retval = [retval; tmp];
5741
07421c4e0312 [project @ 2006-04-05 19:28:35 by jwe]
jwe
parents: 5493
diff changeset
86 endif
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
87 x_set = false;
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
88 y_set = false;
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
89 else
5116
67320fb4ae5c [project @ 2005-01-25 03:57:01 by jwe]
jwe
parents: 5115
diff changeset
90 error ("plot: no data to plot");
67320fb4ae5c [project @ 2005-01-25 03:57:01 by jwe]
jwe
parents: 5115
diff changeset
91 endif
67320fb4ae5c [project @ 2005-01-25 03:57:01 by jwe]
jwe
parents: 5115
diff changeset
92 elseif (x_set)
67320fb4ae5c [project @ 2005-01-25 03:57:01 by jwe]
jwe
parents: 5115
diff changeset
93 if (y_set)
6264
cc2bee854d23 [project @ 2007-02-01 10:00:05 by jwe]
jwe
parents: 6263
diff changeset
94 options = __pltopt__ (caller, {""});
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
95 tmp = __plt2__ (h, x, y, options, properties);
6405
b298a4c12fc3 [project @ 2007-03-14 16:51:28 by jwe]
jwe
parents: 6302
diff changeset
96 retval = [retval; tmp];
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
97 x = next_arg;
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
98 y_set = false;
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
99 properties = {};
5116
67320fb4ae5c [project @ 2005-01-25 03:57:01 by jwe]
jwe
parents: 5115
diff changeset
100 else
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
101 y = next_arg;
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
102 y_set = true;
5116
67320fb4ae5c [project @ 2005-01-25 03:57:01 by jwe]
jwe
parents: 5115
diff changeset
103 endif
67320fb4ae5c [project @ 2005-01-25 03:57:01 by jwe]
jwe
parents: 5115
diff changeset
104 else
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
105 x = next_arg;
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
106 x_set = true;
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
107 endif
934
be867ddbe4aa [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents: 904
diff changeset
108
5118
ecbb290ba9ff [project @ 2005-01-25 22:10:26 by jwe]
jwe
parents: 5117
diff changeset
109 endwhile
934
be867ddbe4aa [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents: 904
diff changeset
110
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
111 else
5119
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
112 msg = sprintf ("%s (y)\n", caller);
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
113 msg = sprintf ("%s %s (x, y, ...)\n", msg, caller);
f394f83ee1c4 [project @ 2005-01-25 22:34:05 by jwe]
jwe
parents: 5118
diff changeset
114 msg = sprintf ("%s %s (x, y, fmt, ...)", msg, caller);
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
115 msg = sprintf ("%s %s (x, y, property, value, ...)", msg, caller);
934
be867ddbe4aa [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents: 904
diff changeset
116 usage (msg);
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
117 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
118
6004
01556febbaaf [project @ 2006-09-26 21:16:52 by jwe]
jwe
parents: 5958
diff changeset
119 endfunction
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6405
diff changeset
120