gimp/pdb/stddefs.pdb
Michael Natterer ef3edece9b pdb: improve docs of deprecated functions
Don't unconditionally overwrite all the proc's description, author
etc.  Instead, try to preserve them and append the "Deprecated" notes
to the help texts and generated comments.

Only affects one procedure because we killed the meta info of all
other deprecated procs so far, but now we don't have to do that any
longer.
2018-04-15 16:06:00 +02:00

194 lines
3.9 KiB
Plaintext

# GIMP - The GNU Image Manipulation Program
# Copyright (C) 1998-2003 Manish Singh <yosh@gimp.org>
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
# Boilerplate PDB stuff
sub std_pdb_misc {
$author = $copyright = 'Spencer Kimball & Peter Mattis';
$date = '1995-1996';
}
sub contrib_pdb_misc {
my $a = shift;
my $e = shift;
my $d = shift;
my $s = shift;
if ($e eq '') {
$author = "$a";
} else {
$author = "$a <$e>";
}
$copyright = "$a";
$date = "$d";
if ($s) {
$since = "$s";
}
}
sub adam_pdb_misc {
contrib_pdb_misc('Adam D. Moss', '', @_);
}
sub adrian_pdb_misc {
contrib_pdb_misc('Adrian Likins', 'adrian@gimp.org', @_);
}
sub adeath_pdb_misc {
contrib_pdb_misc('Alexia Death', '', @_);
}
sub andy_pdb_misc {
contrib_pdb_misc('Andy Thomas', '', @_);
}
sub austin_pdb_misc {
contrib_pdb_misc('Austin Donnelly', '', @_);
}
sub barak_pdb_misc {
contrib_pdb_misc('Barak Itkin', 'lightningismyname@gmail.com', @_);
}
sub bill_pdb_misc {
contrib_pdb_misc('Bill Skaggs', 'weskaggs@primate.ucdavis.edu', @_);
}
sub david_pdb_misc {
contrib_pdb_misc('David Gowers', '', @_);
}
sub ejs_pdb_misc {
contrib_pdb_misc('Ed Swartz', '', @_);
}
sub ell_pdb_misc {
contrib_pdb_misc('Ell', '', @_);
}
sub federico_pdb_misc {
contrib_pdb_misc('Federico Mena Quintero', '', @_);
}
sub jay_pdb_misc {
contrib_pdb_misc('Jay Cox', '', @_);
}
sub jehan_pdb_misc {
contrib_pdb_misc('Jehan', '', @_);
}
sub joao_pdb_misc {
contrib_pdb_misc('Jo\xc3\xa3o S. O. Bueno', '', @_);
}
sub josh_pdb_misc {
contrib_pdb_misc('Josh MacDonald', '', @_);
}
sub kevins_pdb_misc {
contrib_pdb_misc('Kevin Sookocheff', '', @_);
}
sub larry_pdb_misc {
contrib_pdb_misc('Larry Ewing', '', @_);
}
sub marc_pdb_misc {
contrib_pdb_misc('Marc Lehmann', '', @_);
}
sub marcus_pdb_misc {
contrib_pdb_misc('Marcus Heese', 'heese@cip.ifi.lmu.de', @_);
}
sub martin_pdb_misc {
contrib_pdb_misc('Martin Nordholts', '', @_);
}
sub mitch_pdb_misc {
contrib_pdb_misc('Michael Natterer', 'mitch@gimp.org', @_);
}
sub neo_pdb_misc {
contrib_pdb_misc('Sven Neumann', 'sven@gimp.org', @_);
}
sub nick_pdb_misc {
contrib_pdb_misc('Nick Lamb', '', @_);
}
sub raphael_pdb_misc {
contrib_pdb_misc('Rapha\xc3\xabl Quinet', 'raphael@gimp.org', @_);
}
sub rock_pdb_misc {
contrib_pdb_misc('Nathan Summers', 'rock@gimp.org', @_);
}
sub seth_pdb_misc {
contrib_pdb_misc('Seth Burgess', '', @_);
}
sub shlomi_pdb_misc {
contrib_pdb_misc('Shlomi Fish', 'shlomif@iglu.org.il', @_);
}
sub simon_pdb_misc {
contrib_pdb_misc('Simon Budig', '', @_);
}
sub sylvain_pdb_misc {
contrib_pdb_misc('Sylvain Foret', '', @_);
}
sub wolfgang_pdb_misc {
contrib_pdb_misc('Wolfgang Hofer', '', @_);
}
sub yosh_pdb_misc {
contrib_pdb_misc('Manish Singh', '', @_);
}
sub std_pdb_deprecated {
if (@_) {
$blurb = $help = '';
$deprecated = "@_";
} else {
$blurb = $help = '';
$deprecated = "NONE";
}
$author = $copyright = $date = '';
}
sub std_pdb_compat {
$author = $copyright = "Compatibility procedure. Please see '@_' for credits.";
}
sub std_pdb_debug {
$help .= <<'HELP';
This is a debug utility procedure. It is subject to change at any point,
and should not be used in production.
HELP
}
1;