Mercurial > hg > octave-nkf
diff scripts/deprecated/error_text.m @ 12687:6d4c18565de1
Deprecate error_text(), __error_text__()
* __error_text__.m, error_text.m: New functions added to deprecated/ directory
to issue warning message.
* NEWS: Add functions to list of deprecated functions in 3.6.
* mk_undocumented_list: Remove error_text from alias list.
* demo.m, test.m: Replace __error_text__ with lasterr
* error.cc: Remove DEFALIAS of functions to lasterr.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Wed, 25 May 2011 14:09:00 -0700 |
| parents | |
| children | 72c96de7a403 |
line wrap: on
line diff
new file mode 100644 --- /dev/null +++ b/scripts/deprecated/error_text.m @@ -0,0 +1,36 @@ +## Copyright (C) 2011 John W. Eaton +## +## This file is part of Octave. +## +## Octave 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. +## +## Octave 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 Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. + +## -*- texinfo -*- +## @deftypefn {Built-in Function} {[@var{msg}, @var{msgid}] =} error_text (@var{msg}, @var{msgid}) +## This function has been deprecated. Use @code{lasterr} instead. +## @seealso{lasterr} +## @end deftypefn + +function [msg, msgid] = error_text (varargin) + + persistent warned = false; + if (! warned) + warned = true; + warning ("Octave:deprecated-function", + "error_text is obsolete and will be removed from a future version of Octave, please use lasterr instead"); + endif + + [msg, msgid] = lasterr (varargin{:}); + +endfunction