annotate scripts/plot/util/gcbf.m @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
1 ## Copyright (C) 2008-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 ##
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## This file is part of Octave.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
11 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
12 ## (at your option) any later version.
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
17 ## GNU General Public License for more details.
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
21 ## <https://www.gnu.org/licenses/>.
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
23 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
24 ## @deftypefn {} {@var{fig} =} gcbf ()
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
25 ## Return a handle to the figure containing the object whose callback is
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
26 ## currently executing.
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
28 ## If no callback is executing, this function returns the empty matrix. The
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
29 ## handle returned by this function is the same as the second output argument
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
30 ## of @code{gcbo}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
31 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
32 ## @seealso{gcbo, gcf, gco, gca, get, set}
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
33 ## @end deftypefn
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35 function fig = gcbf ()
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36
17480
6e21e858d677 gcbf.m: Ignore unused returned argument from gcbo with '~'.
Rik <rik@octave.org>
parents: 17122
diff changeset
37 [~, fig] = gcbo ();
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 endfunction
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
40
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
41
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
42 %!assert (isempty (gcbf))