annotate scripts/plot/__plt2sv__.m @ 9051:1bf0ce0930be

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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7431
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 2000, 2003, 2005,
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8812
diff changeset
2 ## 2006, 2007, 2008, 2009 John W. Eaton
7431
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
3 ##
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
5 ##
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
9 ## your option) any later version.
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
10 ##
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
14 ## General Public License for more details.
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
15 ##
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
16 ## You should have received a copy of the GNU General Public License
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
18 ## <http://www.gnu.org/licenses/>.
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
19
8812
7d48766c21a5 use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents: 8257
diff changeset
20 ## -*- texinfo -*-
7d48766c21a5 use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents: 8257
diff changeset
21 ## @deftypefn {Function File} {} __plt2sv__ (@var{h}, @var{x}, @var{y}, @var{options}, @var{properties})
7431
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
22 ## Undocumented internal function.
8812
7d48766c21a5 use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents: 8257
diff changeset
23 ## @end deftypefn
7431
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
24
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
25 ## Author: jwe
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
26
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
27 function retval = __plt2sv__ (h, x, y, options, properties)
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
28
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
29 if (nargin < 3 || nargin > 5)
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
30 print_usage ();
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
31 endif
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
32
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
33 if (nargin < 4 || isempty (options))
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
34 options = __default_plot_options__ ();
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
35 endif
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
36
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
37 if (nargin < 5)
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
38 properties = {};
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
39 endif
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
40
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
41 if (isscalar (x) && isvector (y))
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
42 len = numel (y);
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
43 if (numel (options) == 1)
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
44 options = repmat (options(:), len, 1);
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
45 endif
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
46 retval = zeros (len, 1);
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
47 for i = 1:len
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
48 tkey = options(i).key;
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
49 if (! isempty (tkey))
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
50 set (h, "key", "on");
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
51 endif
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
52 color = options(i).color;
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
53 if (isempty (color))
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
54 color = __next_line_color__ ();
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
55 endif
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 7431
diff changeset
56
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8076
diff changeset
57 retval(i) = line (x, y(i), "keylabel", tkey, "color", color,
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8076
diff changeset
58 "linestyle", options(i).linestyle,
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8076
diff changeset
59 "marker", options(i).marker, properties{:});
7431
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
60 endfor
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
61 else
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
62 error ("__plt2sv__: first arg must be scalar, second arg must be vector");
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
63 endif
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
64
1edef460c5fe [project @ 2008-01-30 08:13:52 by jwe]
jwe
parents:
diff changeset
65 endfunction