annotate doc/interpreter/doccheck/mk_undocumented_list @ 31706:597f3ee61a48 stable

update Octave Project Developers copyright for the new year
author John W. Eaton <jwe@octave.org>
date Fri, 06 Jan 2023 13:11:27 -0500
parents 4b80982e0af8
children 24b6c777b7a5
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
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
3 ########################################################################
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 ##
31706
597f3ee61a48 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 31535
diff changeset
5 ## Copyright (C) 2010-2023 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
6 ##
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 ## distribution or <https://octave.org/copyright/>.
22799
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
9 ##
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
10 ## This file is part of Octave.
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
11 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23221
diff changeset
12 ## 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
13 ## 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
14 ## 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
15 ## (at your option) any later version.
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
16 ##
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
17 ## 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
18 ## 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
19 ## 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
20 ## GNU General Public License for more details.
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
21 ##
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
22 ## 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
23 ## 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
24 ## <https://www.gnu.org/licenses/>.
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
25 ##
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
26 ########################################################################
22799
592fa741e0aa add missing copyright notices (bug #49624)
John W. Eaton <jwe@octave.org>
parents: 22341
diff changeset
27
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
28 ################################################################################
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
29 # File: mk_undocumented_list
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
30 # 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
31 # 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
32 # Usage: make doc/interpreter/undocumented_list
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
33 # Documentation: see README in doccheck directory
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
34 ################################################################################
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
35 # 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
36 @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
37 ../../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
38 funclist = vertcat (__list_functions__ , __builtins__); \
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
39 funclist = funclist(! strncmp (funclist, \"meta.\", 5)) \
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
40 disp ("#!-separator-!#") \
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
41 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
42 _END_OCT_SCRIPT_
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
43
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
44 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
45
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
46 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
47 # 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
48
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
49 # 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
50 $idx = 0;
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
51 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
52 {
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
53 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
54 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
55 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
56 {
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
57 push(@where, $1) if (/] = (.+)$/);
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
58 }
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
59
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
60 # 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
61 if ($#all_functions != $#where)
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
62 {
25115
e512eaba5206 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
63 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
64 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
65
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
66 # Second, remove functions based on directory location
28962
90c39bbbe5cd doc: Review doccheck files for checking documentation.
Rik <rik@octave.org>
parents: 27923
diff changeset
67 # deprecated directory, legacy directory, doc/interpreter directory,
90c39bbbe5cd doc: Review doccheck files for checking documentation.
Rik <rik@octave.org>
parents: 27923
diff changeset
68 # test/ directory
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
69 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
70 {
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
71 next FUNC if ($where[$idx] =~ /deprecated/i);
28962
90c39bbbe5cd doc: Review doccheck files for checking documentation.
Rik <rik@octave.org>
parents: 27923
diff changeset
72 next FUNC if ($where[$idx] =~ /legacy/i);
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
73 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
74 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
75
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
76 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
77 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
78
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
79 # Third, remove functions based on naming patterns
12174
db1f49eaba6b whitespace fixes
John W. Eaton <jwe@octave.org>
parents: 11545
diff changeset
80 # 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
81 @functions = grep (! /^__/, @functions);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
82
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
83 # 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
84 # 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
85 # Exception data is stored at the bottom of this script
28962
90c39bbbe5cd doc: Review doccheck files for checking documentation.
Rik <rik@octave.org>
parents: 27923
diff changeset
86 foreach $_ (<DATA>)
90c39bbbe5cd doc: Review doccheck files for checking documentation.
Rik <rik@octave.org>
parents: 27923
diff changeset
87 { chomp, $exceptions{$_}=1; }
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
88
11387
2750b04a1b5c Update script to generate undocumented function list.
Rik <octave@nomad.inbox5.com>
parents: 11373
diff changeset
89 # 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
90 @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
91
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
92 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
93 # 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
94 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
95 {
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
96 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
97 while (<TXI_FILE>)
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
98 {
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
99 $docstrings{$1} = 1 if (/\@DOCSTRING\((\w+)\)/);
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
100 }
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
101 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
102
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 # 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
105 @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
106
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
107 # 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
108 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
109
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
110 $, = "\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
111 print sort(@undocumented);
22341
770fb2070e96 doc: Clean up tools used to check Texinfo documentation.
Rik <rik@octave.org>
parents: 20745
diff changeset
112 print "\n";
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
113 exit(1);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
114
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
115 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
116 # 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
117 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
118 __DATA__
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
119 angle
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
120 bessel
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
121 besselh
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
122 besseli
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
123 besselk
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
124 bessely
11545
a34ccc8e2f8e Update list of exceptions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11431
diff changeset
125 bug_report
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
126 chdir
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
127 dbnext
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
128 debug
17756
9aff1c9fd70f doc: Add missing functions to manual.
Rik <rik@octave.org>
parents: 14171
diff changeset
129 end
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
130 exit
11373
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
131 F_DUPFD
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
132 F_GETFD
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
133 F_GETFL
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
134 F_SETFD
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
135 F_SETFL
14171
2ced2f59f523 doc: miscellaneous documentation improvements
Rik <octave@nomad.inbox5.com>
parents: 14018
diff changeset
136 fact
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 11387
diff changeset
137 finite
20718
aaaaca0891be build: Update mk_undocumented_list Perl script.
Rik <rik@octave.org>
parents: 17756
diff changeset
138 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
139 fmod
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
140 gammaln
28962
90c39bbbe5cd doc: Review doccheck files for checking documentation.
Rik <rik@octave.org>
parents: 27923
diff changeset
141 gui_mainfcn
11545
a34ccc8e2f8e Update list of exceptions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11431
diff changeset
142 home
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
143 i
12190
66b2c377b38e Add sizemax function to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12174
diff changeset
144 ifelse
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
145 import
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
146 inf
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
147 inverse
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 11387
diff changeset
148 isbool
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 11387
diff changeset
149 isfinite
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
150 J
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
151 j
20718
aaaaca0891be build: Update mk_undocumented_list Perl script.
Rik <rik@octave.org>
parents: 17756
diff changeset
152 java2mat
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
153 lower
11545
a34ccc8e2f8e Update list of exceptions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11431
diff changeset
154 lstat
20745
c4f79fc9281a doc: Resolve two undocumented functions in manual.
Rik <rik@octave.org>
parents: 20718
diff changeset
155 metaclass
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
156 nan
20718
aaaaca0891be build: Update mk_undocumented_list Perl script.
Rik <rik@octave.org>
parents: 17756
diff changeset
157 nargchk
11373
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
158 O_APPEND
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
159 O_ASYNC
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
160 O_CREAT
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
161 O_EXCL
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
162 O_NONBLOCK
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
163 O_RDONLY
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
164 O_RDWR
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
165 O_SYNC
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
166 O_TRUNC
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
167 O_WRONLY
20718
aaaaca0891be build: Update mk_undocumented_list Perl script.
Rik <rik@octave.org>
parents: 17756
diff changeset
168 putenv
25011
231847364696 doc: Add discrete_rnd and empirical_rnd DOCSTRINGs to manual.
Rik <rik@octave.org>
parents: 25009
diff changeset
169 rticks
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
170 setenv
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
171 slash
25011
231847364696 doc: Add discrete_rnd and empirical_rnd DOCSTRINGs to manual.
Rik <rik@octave.org>
parents: 25009
diff changeset
172 thetaticks
11153
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions.
Rik <octave@nomad.inbox5.com>
parents:
diff changeset
173 upper
11373
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
174 ylabel
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
175 ylim
31535
4b80982e0af8 doc: Add undocumented functions to Octave manual for 8.1 release.
Rik <rik@octave.org>
parents: 30564
diff changeset
176 ytickangle
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
177 yticklabels
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
178 yticks
11373
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
179 zlabel
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation.
Rik <octave@nomad.inbox5.com>
parents: 11372
diff changeset
180 zlim
31535
4b80982e0af8 doc: Add undocumented functions to Octave manual for 8.1 release.
Rik <rik@octave.org>
parents: 30564
diff changeset
181 ztickangle
25009
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
182 zticklabels
92252c8c7559 mk_undocumented_list: Check intermediate results for sanity before continuing.
Rik <rik@octave.org>
parents: 24534
diff changeset
183 zticks