Mercurial > octave

annotate doc/interpreter/doccheck/mk_undocumented_list @ 27919:1891570abac8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
1 #!/usr/bin/perl -w
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
2
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 ## Copyright (C) 2010-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4 ##
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
6 ## or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
7 ##
22799
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
8 ##
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
9 ## This file is part of Octave.
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
10 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23221
diff changeset
11 ## Octave is free software: you can redistribute it and/or modify it
22799
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
12 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23221
diff changeset
13 ## the Free Software Foundation, either version 3 of the License, or
22799
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
14 ## (at your option) any later version.
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
15 ##
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
16 ## Octave is distributed in the hope that it will be useful, but
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
17 ## WITHOUT ANY WARRANTY; without even the implied warranty of
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
18 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
19 ## GNU General Public License for more details.
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
20 ##
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
21 ## You should have received a copy of the GNU General Public License
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
22 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23221
diff changeset
23 ## <https://www.gnu.org/licenses/>.
22799
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
24
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
25 ################################################################################
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
26 # File: mk_undocumented_list
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
27 # Purpose: Create a list of functions present in Octave, but without a
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
28 # corresponding DOCSTRING entry in one of the *.txi files
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
29 # Usage: make doc/interpreter/undocumented_list
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
30 # Documentation: see README in doccheck directory
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
31 ################################################################################
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
32 # Get a list from Octave of all visible functions
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
33 @octave_output = <<`_END_OCT_SCRIPT_`;
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
34 ../../run-octave --norc --silent --no-history --eval '\
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
35 funclist = vertcat (__list_functions__ , __builtins__); \
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
36 funclist = funclist(! strncmp (funclist, \"meta.\", 5)) \
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
37 disp ("#!-separator-!#") \
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
38 where = cellfun (\@which, funclist, \"UniformOutput\", 0)'
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
39 _END_OCT_SCRIPT_
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
40
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
41 unless (@octave_output) { die "Unable to invoke 'run-octave'. Exiting\n" }
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
42
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
43 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
44 # Winnow list of functions that require a DOCSTRING
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
45
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
46 # First, divide output in to list of functions and list of locations
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
47 $idx = 0;
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
48 while (($_ = $octave_output[$idx++]) !~ /^#!-separator-!#$/)
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
49 {
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
50 push(@all_functions, $1) if (/] = (\w+)$/);
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
51 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
52 while ($_ = $octave_output[$idx++])
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
53 {
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
54 push(@where, $1) if (/] = (.+)$/);
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
55 }
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
56
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
57 # Sanity check that Octave script worked
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
58 if ($#all_functions != $#where)
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
59 {
25115
e512eaba5206 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
60 die "Unequal number of functions and locations. Parsing failed\n";
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
61 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
62
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
63 # Second, remove functions based on directory location
11387
2750b04a1b5c Update script to generate undocumented function list.
Rik <octave@nomad.inbox5.com>
parents: 11373
diff changeset
64 # deprecated directory, doc/interpreter directory, test/ directory
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
65 FUNC: foreach $idx (0 .. $#where)
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
66 {
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
67 next FUNC if ($where[$idx] =~ /deprecated/i);
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
68 next FUNC if ($where[$idx] =~ /interpreter/i);
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
69 next FUNC if ($where[$idx] =~ m#test/#i);
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
70
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
71 push (@functions, $all_functions[$idx]);
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
72 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
73
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
74 # Third, remove functions based on naming patterns
12174
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11545
diff changeset
75 # Remove internal functions from the list of features requiring a DOCSTRING
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
76 @functions = grep (! /^__/, @functions);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
77
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
78 # Fourth, remove exceptions based on name that do not require documentation
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
79 # Load list of function exceptions not requiring a DOCSTRING
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
80 # Exception data is stored at the bottom of this script
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
81 map { chomp, $exceptions{$_}=1; } <DATA>;
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
82
11387
2750b04a1b5c Update script to generate undocumented function list.
Rik <octave@nomad.inbox5.com>
parents: 11373
diff changeset
83 # Remove exception data from the list
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
84 @functions = grep (! $exceptions{$_}, @functions);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
85
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
86 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
87 # Get a list of all documented functions
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
88 foreach $txi_file (glob("*.txi"))
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
89 {
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
90 open(TXI_FILE, $txi_file) or die "Unable to open $txi_file for reading\n";
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
91 while (<TXI_FILE>)
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
92 {
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
93 $docstrings{$1} = 1 if (/\@DOCSTRING\((\w+)\)/);
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
94 }
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
95 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
96
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
97 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
98 # Find features which have not been documented in the txi files
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
99 @undocumented = grep (! $docstrings{$_}, @functions);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
100
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
101 # Exit successfully if no undocumented functions
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
102 exit(0) if (! @undocumented);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
103
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
104 $, = "\n"; # Set output record separator
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
105 print sort(@undocumented);
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
106 print "\n";
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
107 exit(1);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
108
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
109 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
110 # Exception list of functions not requiring a DOCSTRING
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
111 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
112 __DATA__
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
113 angle
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
114 bessel
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
115 besselh
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
116 besseli
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
117 besselk
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
118 bessely
11545
a34ccc8e2f8e Update list of exceptions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11431
diff changeset
119 bug_report
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
120 chdir
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
121 dbnext
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
122 debug
17756
9aff1c9fd70f doc: Add missing functions to manual.
Rik <rik@octave.org>
parents: 14171
diff changeset
123 end
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
124 exit
11373
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
125 F_DUPFD
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
126 F_GETFD
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
127 F_GETFL
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
128 F_SETFD
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
129 F_SETFL
14171
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14018
diff changeset
130 fact
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 11387
diff changeset
131 finite
20718
aaaaca0891be build: Update mk_undocumented_list Perl script.
Rik <rik@octave.org>
parents: 17756
diff changeset
132 flipdim
12513
6a50edfb186b Add fmod, octave_tmp_file_name to list of exceptions not needing a DOCSTRING.
Rik <octave@nomad.inbox5.com>
parents: 12346
diff changeset
133 fmod
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
134 gammaln
11545
a34ccc8e2f8e Update list of exceptions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11431
diff changeset
135 home
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
136 i
12190
66b2c377b38e Add sizemax function to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12174
diff changeset
137 ifelse
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
138 import
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
139 inf
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
140 inverse
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 11387
diff changeset
141 isbool
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 11387
diff changeset
142 isfinite
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
143 J
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
144 j
20718
aaaaca0891be build: Update mk_undocumented_list Perl script.
Rik <rik@octave.org>
parents: 17756
diff changeset
145 java2mat
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
146 lower
11545
a34ccc8e2f8e Update list of exceptions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11431
diff changeset
147 lstat
20745
c4f79fc9281a doc: Resolve two undocumented functions in manual.
Rik <rik@octave.org>
parents: 20718
diff changeset
148 metaclass
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
149 nan
20718
aaaaca0891be build: Update mk_undocumented_list Perl script.
Rik <rik@octave.org>
parents: 17756
diff changeset
150 nargchk
11373
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
151 O_APPEND
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
152 O_ASYNC
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
153 O_CREAT
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
154 O_EXCL
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
155 O_NONBLOCK
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
156 O_RDONLY
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
157 O_RDWR
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
158 O_SYNC
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
159 O_TRUNC
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
160 O_WRONLY
20718
aaaaca0891be build: Update mk_undocumented_list Perl script.
Rik <rik@octave.org>
parents: 17756
diff changeset
161 putenv
25011
231847364696 doc: Add discrete_rnd and empirical_rnd DOCSTRINGs to manual.
Rik <rik@octave.org>
parents: 25009
diff changeset
162 rticks
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
163 setenv
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
164 slash
25011
231847364696 doc: Add discrete_rnd and empirical_rnd DOCSTRINGs to manual.
Rik <rik@octave.org>
parents: 25009
diff changeset
165 thetaticks
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
166 upper
11373
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
167 ylabel
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
168 ylim
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
169 yticklabels
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
170 yticks
11373
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
171 zlabel
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
172 zlim
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
173 zticklabels
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
174 zticks