octave-lyh: doc/interpreter/doccheck/mk_undocumented

annotate doc/interpreter/doccheck/mk_undocumented_list @ 17483:bddb9688e41c

feather.m: Overhaul function for Matlab visual compatibility. * scripts/plot/feather.m: Reduce length of arrowhead size to 0.20 of arrow shaft. Change arrow head angle with shaft from 45 to 30 degrees. Use variable 'h' instead of 'retval' to match documentation. Redo input validation. Add %!error input validation tests.

author	Rik <rik@octave.org>
date	Tue, 24 Sep 2013 13:17:04 -0700
parents	2ced2f59f523
children

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
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	3 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	4 # 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	5 @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	6 ../../run-octave --norc --silent --no-history --eval '\
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	7 funclist = vertcat (__list_functions__ , __builtins__) \
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	8 disp("#!-separator-!#") \
12174 db1f49eaba6b whitespace fixes John W. Eaton <jwe@octave.org> parents: 11545 diff changeset	9 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	10 _END_OCT_SCRIPT_
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	11
14171 2ced2f59f523 doc: miscellaneous documentation improvements Rik <octave@nomad.inbox5.com> parents: 14018 diff changeset	12 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	13
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	14 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	15 # 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	16
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	17 $idx = 0;
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	18 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	19 {
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	20 push(@all_functions, $1) if (/] = (\w+)$/);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	21 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	22 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	23 {
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	24 push(@where, $1) if (/] = (\S*)$/);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	25 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	26
11387 2750b04a1b5c Update script to generate undocumented function list. Rik <octave@nomad.inbox5.com> parents: 11373 diff changeset	27 # Remove functions based on directory location
2750b04a1b5c Update script to generate undocumented function list. Rik <octave@nomad.inbox5.com> parents: 11373 diff changeset	28 # 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	29 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	30 {
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	31 next FUNC if ($where[$idx] =~ /deprecated/i);
11387 2750b04a1b5c Update script to generate undocumented function list. Rik <octave@nomad.inbox5.com> parents: 11373 diff changeset	32 next FUNC if ($where[$idx] =~ /interpreter/i);
2750b04a1b5c Update script to generate undocumented function list. Rik <octave@nomad.inbox5.com> parents: 11373 diff changeset	33 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	34
12174 db1f49eaba6b whitespace fixes John W. Eaton <jwe@octave.org> parents: 11545 diff changeset	35 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	36 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	37
12174 db1f49eaba6b whitespace fixes John W. Eaton <jwe@octave.org> parents: 11545 diff changeset	38 # 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	39 @functions = grep (! /^__/, @functions);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	40
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	41 # 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	42 # 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	43 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	44
11387 2750b04a1b5c Update script to generate undocumented function list. Rik <octave@nomad.inbox5.com> parents: 11373 diff changeset	45 # 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	46 @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	47
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	48 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	49 # 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	50 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	51 {
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	52 open(TXI_FILE, $txi_file) or die "Unable to open $txi_file for reading\n";
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	53 while (<TXI_FILE>)
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 $docstrings{$1} = 1 if (/\@DOCSTRING$(\w+)$/) ;
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	56 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	57 }
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	58
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	59 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	60 # 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	61 @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	62
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	63 # 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	64 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	65
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	66 $, = "\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	67 print sort(@undocumented);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	68 exit(1);
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	69
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	70 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	71 # 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	72 ################################################################################
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	73 __DATA__
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	74 angle
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	75 bessel
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	76 besselh
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	77 besseli
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	78 besselk
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	79 bessely
11545 a34ccc8e2f8e Update list of exceptions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	80 bug_report
11153 3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	81 chdir
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	82 comma
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	83 debug
12346 e1da28034c73 Update list of functions not requiring a docstring. Rik <octave@nomad.inbox5.com> parents: 12190 diff changeset	84 dbnext
11153 3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	85 exit
11373 a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	86 F_DUPFD
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	87 F_GETFD
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	88 F_GETFL
14171 2ced2f59f523 doc: miscellaneous documentation improvements Rik <octave@nomad.inbox5.com> parents: 14018 diff changeset	89 fact
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11387 diff changeset	90 finite
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	91 fmod
11373 a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	92 F_SETFD
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	93 F_SETFL
11153 3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	94 gammaln
11545 a34ccc8e2f8e Update list of exceptions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	95 home
11153 3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	96 i
12190 66b2c377b38e Add sizemax function to documentation. Rik <octave@nomad.inbox5.com> parents: 12174 diff changeset	97 ifelse
11153 3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	98 inf
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	99 inverse
11431 0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11387 diff changeset	100 isbool
0d9640d755b1 Improve docstrings for all isXXX functions. Rik <octave@nomad.inbox5.com> parents: 11387 diff changeset	101 isfinite
11153 3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	102 j
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	103 J
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	104 lower
11545 a34ccc8e2f8e Update list of exceptions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11431 diff changeset	105 lstat
11153 3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	106 nan
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	107 octave_tmp_file_name
11373 a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	108 O_APPEND
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	109 O_ASYNC
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	110 O_CREAT
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	111 O_EXCL
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	112 O_NONBLOCK
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	113 O_RDONLY
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	114 O_RDWR
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	115 O_SYNC
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	116 O_TRUNC
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	117 O_WRONLY
11153 3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	118 paren
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	119 SEEK_CUR
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	120 SEEK_END
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	121 semicolon
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	122 setenv
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	123 toc
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	124 triu
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	125 unimplemented
3ddf14b8196f New verification script, mk_undocumented_list, produces a list of undocumented functions. Rik <octave@nomad.inbox5.com> parents: diff changeset	126 upper
11373 a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	127 ylabel
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	128 ylim
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	129 zlabel
a41acdfa97dc mk_undocumented_list: Update list of exception functions not requiring documentation. Rik <octave@nomad.inbox5.com> parents: 11372 diff changeset	130 zlim

Mercurial > hg > octave-lyh

annotate doc/interpreter/doccheck/mk_undocumented_list @ 17483:bddb9688e41c