Mercurial > hg > octave-lyh

annotate scripts/deprecated/error_text.m @ 12687:6d4c18565de1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12687
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
1 ## Copyright (C) 2011 John W. Eaton
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
2 ##
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
3 ## This file is part of Octave.
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
4 ##
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
8 ## your option) any later version.
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
9 ##
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
13 ## General Public License for more details.
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
14 ##
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
18
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
19 ## -*- texinfo -*-
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
20 ## @deftypefn {Built-in Function} {[@var{msg}, @var{msgid}] =} error_text (@var{msg}, @var{msgid})
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
21 ## This function has been deprecated. Use @code{lasterr} instead.
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
22 ## @seealso{lasterr}
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
23 ## @end deftypefn
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
24
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
25 function [msg, msgid] = error_text (varargin)
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
26
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
27 persistent warned = false;
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
28 if (! warned)
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
29 warned = true;
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
30 warning ("Octave:deprecated-function",
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
31 "error_text is obsolete and will be removed from a future version of Octave, please use lasterr instead");
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
32 endif
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
33
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
34 [msg, msgid] = lasterr (varargin{:});
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
35
6d4c18565de1 Deprecate error_text(), __error_text__()
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
36 endfunction