annotate scripts/legacy/@inline/char.m @ 30910:78c3dcadf130

maint: Remove unnecessary input validation from @style classes The Octave interpreter guarantees that the first argument to an old-style @class is the object itself so there is no need to check for it. * cd.m, disp.m, argnames.m, char.m, feval.m, formula.m, vectorize.m: Remove check for 1 argument to function.
author Rik <rik@octave.org>
date Wed, 06 Apr 2022 16:30:23 -0700
parents 5d3faba0342e
children b7edac56a810
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
28459
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
1 ########################################################################
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
2 ##
30564
796f54d4ddbf update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 29359
diff changeset
3 ## Copyright (C) 2020-2022 The Octave Project Developers
28459
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
4 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
7 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
8 ## This file is part of Octave.
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
9 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
11 ## under the terms of the GNU General Public License as published by
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
13 ## (at your option) any later version.
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
14 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
18 ## GNU General Public License for more details.
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
19 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
20 ## You should have received a copy of the GNU General Public License
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
21 ## along with Octave; see the file COPYING. If not, see
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
22 ## <https://www.gnu.org/licenses/>.
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
23 ##
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
24 ########################################################################
0d56bfb63b90 add copyright notices omitted from some @inline class methods
John W. Eaton <jwe@octave.org>
parents: 28427
diff changeset
25
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 ## -*- texinfo -*-
30875
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
27 ## @deftypefn {} {@var{fcnstr} =} char (@var{fcn})
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
28 ## Return a character string representing the inline function @var{fcn}.
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29 ##
30875
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
30 ## Note that @code{char (@var{fcn})} is equivalent to
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
31 ## @code{formula (@var{fcn})}.
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
32 ## @seealso{char, argnames, inline, vectorize}
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33 ## @end deftypefn
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34
30875
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
35 function fcnstr = char (obj)
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36
30875
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files.
Rik <rik@octave.org>
parents: 30564
diff changeset
37 fcnstr = obj.expr;
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 endfunction