annotate scripts/plot/hggroup.m @ 11540:b0ef6f28e09a

deprecate krylovb function
author John W. Eaton <jwe@octave.org>
date Sat, 15 Jan 2011 03:40:32 -0500
parents fd0a3ac60b0e
children 6efa1a691713
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 10793
diff changeset
1 ## Copyright (C) 2008-2011 Michael Goffioul
7865
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
2 ##
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
3 ## This file is part of Octave.
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
4 ##
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
8 ## your option) any later version.
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
9 ##
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
13 ## General Public License for more details.
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
14 ##
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
18
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
20 ## @deftypefn {Function File} {} hggroup ()
7865
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
21 ## @deftypefnx {Function File} {} hggroup (@var{h})
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
22 ## @deftypefnx {Function File} {} hggroup (@dots{}, @var{property}, @var{value}, @dots{})
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 7865
diff changeset
23 ## Create group object with parent @var{h}. If no parent is specified,
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 7865
diff changeset
24 ## the group is created in the current axes. Return the handle of the
7865
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
25 ## group object created.
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
26 ##
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
27 ## Multiple property-value pairs may be specified for the group, but they
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
28 ## must appear in pairs.
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
29 ## @end deftypefn
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
30
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
31 ## Author: goffioul
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
32
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
33 function h = hggroup (varargin)
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
34
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
35 [ax, varargin] = __plt_get_axis_arg__ ("hggroup", varargin{:});
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
36
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
37 tmp = __go_hggroup__ (ax, varargin{:});
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
38
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
39 if (nargout > 0)
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
40 h = tmp;
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
41 endif
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
42
b74039822fd2 Add support for hggroup
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
43 endfunction