annotate scripts/gui/uipanel.m @ 27918:b442ec6dda5c

use centralized file for copyright info for individual contributors * COPYRIGHT.md: New file. * In most other files, use "Copyright (C) YYYY-YYYY The Octave Project Developers" instead of tracking individual names in separate source files. The motivation is to reduce the effort required to update the notices each year. Until now, the Octave source files contained copyright notices that list individual contributors. I adopted these file-scope copyright notices because that is what everyone was doing 30 years ago in the days before distributed version control systems. But now, with many contributors and modern version control systems, having these file-scope copyright notices causes trouble when we update copyright years or refactor code. Over time, the file-scope copyright notices may become outdated as new contributions are made or code is moved from one file to another. Sometimes people contribute significant patches but do not add a line claiming copyright. Other times, people add a copyright notice for their contribution but then a later refactoring moves part or all of their contribution to another file and the notice is not moved with the code. As a practical matter, moving such notices is difficult -- determining what parts are due to a particular contributor requires a time-consuming search through the project history. Even managing the yearly update of copyright years is problematic. We have some contributors who are no longer living. Should we update the copyright dates for their contributions when we release new versions? Probably not, but we do still want to claim copyright for the project as a whole. To minimize the difficulty of maintaining the copyright notices, I would like to change Octave's sources to use what is described here: https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html in the section "Maintaining centralized copyright notices": The centralized notice approach consolidates all copyright notices in a single location, usually a top-level file. This file should contain all of the copyright notices provided project contributors, unless the contribution was clearly insignificant. It may also credit -- without a copyright notice -- anyone who helped with the project but did not contribute code or other copyrighted material. This approach captures less information about contributions within individual files, recognizing that the DVCS is better equipped to record those details. As we mentioned before, it does have one disadvantage as compared to the file-scope approach: if a single file is separated from the distribution, the recipient won't see the contributors' copyright notices. But this can be easily remedied by including a single copyright notice in each file's header, pointing to the top-level file: Copyright YYYY-YYYY The Octave Project Developers See the COPYRIGHT file at the top-level directory of this distribution or at https://octave.org/COPYRIGHT.html. followed by the usual GPL copyright statement. For more background, see the discussion here: https://lists.gnu.org/archive/html/octave-maintainers/2020-01/msg00009.html Most files in the following directories have been skipped intentinally in this changeset: doc libgui/qterminal liboctave/external m4
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 15:38:17 -0500
parents 83774c2a1b92
children 1891570abac8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26877
diff changeset
1 ## Copyright (C) 2012-2019 The Octave Project Developers
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26877
diff changeset
2 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26877
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: 26877
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: 26877
diff changeset
5 ##
13284
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
6 ##
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
7 ## This file is part of Octave.
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
8 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23396
diff changeset
9 ## Octave is free software: you can redistribute it and/or modify it
13284
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
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: 23396
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.
13284
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
13 ##
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
14 ## Octave is distributed in the hope that it will be useful, but
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
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.
13284
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
18 ##
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
19 ## You should have received a copy of the GNU General Public License
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
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: 23396
diff changeset
21 ## <https://www.gnu.org/licenses/>.
13284
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
22
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
23 ## -*- texinfo -*-
23271
cc9dcadcef6b Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents: 23220
diff changeset
24 ## @deftypefn {} {} uipanel (@var{property}, @var{value}, @dots{})
26577
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
25 ## @deftypefnx {} {} uipanel (@var{parent}, @var{property}, @var{value}, @dots{})
23271
cc9dcadcef6b Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents: 23220
diff changeset
26 ## @deftypefnx {} {@var{hui} =} uipanel (@dots{})
20597
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
27 ##
23271
cc9dcadcef6b Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents: 23220
diff changeset
28 ## Create a uipanel object.
20597
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
29 ##
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
30 ## uipanels are used as containers to group other uicontrol objects.
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
31 ##
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
32 ## If @var{parent} is omitted then a uipanel for the current figure is
20716
1ecee53513d7 doc: Peridodic grammar check of documentation.
Rik <rik@octave.org>
parents: 20715
diff changeset
33 ## created. If no figure is available, a new figure is created first.
20597
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
34 ##
20715
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20615
diff changeset
35 ## If @var{parent} is given then a uipanel relative to @var{parent} is created.
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20615
diff changeset
36 ##
20716
1ecee53513d7 doc: Peridodic grammar check of documentation.
Rik <rik@octave.org>
parents: 20715
diff changeset
37 ## Any provided property value pairs will override the default values of the
1ecee53513d7 doc: Peridodic grammar check of documentation.
Rik <rik@octave.org>
parents: 20715
diff changeset
38 ## created uipanel object.
20597
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
39 ##
26877
83774c2a1b92 doc: Place cross-reference from list of graphics object properties back to object (bug #46076).
Rik <rik@octave.org>
parents: 26577
diff changeset
40 ## The full list of properties is documented at @ref{Uipanel Properties}.
20615
93d96da9ff3e Update uiXXXXX documentation for autogenerated properties
John Donoghue
parents: 20597
diff changeset
41 ##
23271
cc9dcadcef6b Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents: 23220
diff changeset
42 ## The optional return value @var{hui} is a graphics handle to the created
cc9dcadcef6b Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents: 23220
diff changeset
43 ## uipanel object.
cc9dcadcef6b Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents: 23220
diff changeset
44 ##
20597
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
45 ## Examples:
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
46 ##
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
47 ## @example
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
48 ## @group
26577
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
49 ## ## create figure and panel on it
20597
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
50 ## f = figure;
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
51 ## p = uipanel ("title", "Panel Title", "position", [.25 .25 .5 .5]);
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
52 ##
26577
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
53 ## ## add two buttons to the panel
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
54 ## b1 = uicontrol ("parent", p, "string", "A Button", ...
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
55 ## "position", [18 10 150 36]);
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
56 ## b2 = uicontrol ("parent", p, "string", "Another Button", ...
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
57 ## "position",[18 60 150 36]);
20597
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
58 ##
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
59 ## @end group
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
60 ## @end example
7890893a0e69 Add uiXXXX documentation (Bug #46076)
John Donoghue <john.donoghue@ieee.org>
parents: 19833
diff changeset
61 ## @seealso{figure, uicontrol}
13284
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
62 ## @end deftypefn
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
63
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
64 ## Author: goffioul
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
65
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
66 function hui = uipanel (varargin)
13284
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
67
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
68 [h, args] = __uiobject_split_args__ ("uipanel", varargin,
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
69 {"figure", "uipanel", "uibuttongroup"});
23271
cc9dcadcef6b Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents: 23220
diff changeset
70 htmp = __go_uipanel__ (h, args{:});
23396
945b53af4655 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 23271
diff changeset
71
23271
cc9dcadcef6b Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents: 23220
diff changeset
72 if (nargout > 0)
cc9dcadcef6b Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents: 23220
diff changeset
73 hui = htmp;
cc9dcadcef6b Only return a handle from ui* functions if nargout > 0 (bug #49751).
Rik <rik@octave.org>
parents: 23220
diff changeset
74 endif
13284
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
75
5ab9c721ce59 Add uicontrol and uipanel m-scripts.
Michael Goffioul <michael.goffioul@gmail.com>
parents:
diff changeset
76 endfunction