annotate scripts/deprecated/setstr.m @ 10216:f3c1fd990f3f

note some deprecated functions are still in Matlab, so don't remove with other functions deprecated in 3.0.0
author John W. Eaton <jwe@octave.org>
date Thu, 28 Jan 2010 07:43:28 -0500
parents eb63fbe60fab
children fd0a3ac60b0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 7704
diff changeset
1 ## Copyright (C) 2003, 2005, 2007, 2008 John W. Eaton
4358
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
2 ##
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
4 ##
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
8 ## your option) any later version.
4358
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
9 ##
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
14 ##
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
17 ## <http://www.gnu.org/licenses/>.
4358
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
18
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {} setstr (@var{s})
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
21 ## This function has been deprecated. Use char instead.
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
22 ## @end deftypefn
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
23
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
24 ## Author: jwe
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
25
7693
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
26 ## Deprecated in version 3.0
10216
f3c1fd990f3f note some deprecated functions are still in Matlab, so don't remove with other functions deprecated in 3.0.0
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
27 ## Matlab still has this function, so don't remove just yet.
7693
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
28
4358
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
29 function retval = setstr (varargin)
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
30
7696
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
31 persistent warned = false;
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
32 if (! warned)
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
33 warned = true;
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
34 warning ("Octave:deprecated-function",
7704
1cdb42b372e8 don't embed newline in warning messages in deprecated functions
John W. Eaton <jwe@octave.org>
parents: 7696
diff changeset
35 "setstr is obsolete and will be removed from a future version of Octave; please use char instead");
7696
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
36 endif
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
37
4358
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
38 retval = char (varargin{:});
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
39
83d4452bc522 [project @ 2003-02-23 02:16:53 by jwe]
jwe
parents:
diff changeset
40 endfunction