annotate scripts/deprecated/nfields.m @ 19774:f64cdbe11621

doc: Periodic spellcheck of documentation. * aspell-octave.en.pws: Add new audio keywords to private dictionary. * audiodevinfo.cc: Wrap DriverVersion with @nospell directive.
author Rik <rik@octave.org>
date Tue, 13 Jan 2015 22:11:45 -0800
parents fcd87f68af4f
children ebd27d8c63fd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18606
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
1 ## Copyright (C) 2014 Rik Wehbring
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
8 ## your option) any later version.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
18
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
20 ## @deftypefn {Function File} {} nfields (@var{s})
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
21 ## Return the number of fields of the structure @var{s}.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
22 ##
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
23 ## @strong{Warning:} @code{nfields} is scheduled for removal in version 4.6.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
24 ## Use @code{numfields} instead.
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
25 ## @seealso{numfields, fieldnames}
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
26 ## @end deftypefn
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
27
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
28 function retval = nfields (varargin)
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
29
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
30 persistent warned = false;
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
31 if (! warned)
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
32 warned = true;
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
33 warning ("Octave:deprecated-function",
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
34 "nfields is obsolete and will be removed from a future version of Octave; please use numfields instead");
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
35 endif
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
36
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
37 if (nargin < 1)
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
38 print_usage ();
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
39 endif
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
40
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
41 retval = numfields (varargin{:});
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
42
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
43 endfunction
fcd87f68af4f Deprecate nfields and replace with numfields.
Rik <rik@octave.org>
parents:
diff changeset
44