Re: Undocumented functions

[Rik]

10/24/10

Octave coders,

I've checked in a new script,
'doc/interpeter/doccheck/mk_undocumented_list'.  There is a README in the
directory which more fully documents it.

Briefly, to run:
cd doc/interpreter
./doccheck/mk_undocumented_list

This produces a list of functions which Octave is aware of, but for which
there is no @DOCSTRING reference in the printed documentation.  Some
functions will not require a reference.  For example, comma.m, exists as a
function only to supply a help string at the command line.  Other examples
are chdir, which is documented by the DOCSTRING 'cd'.  If you need to add
an exception, just place the function name at the bottom of the
mk_undocumented_list script and it will cease being reported as missing.
Otherwise, the correct thing to do is find an appropriate place in one of
the *.txi files and add @DOCSTRING(my_undocumented_function).

The current list of undocumented functions is:
F_DUPFD
F_GETFD
F_GETFL
F_SETFD
F_SETFL
O_APPEND
O_ASYNC
O_CREAT
O_EXCL
O_NONBLOCK
O_RDONLY
O_RDWR
O_SYNC
O_TRUNC
O_WRONLY
S_ISBLK
S_ISCHR
S_ISDIR
S_ISFIFO
S_ISLNK
S_ISREG
S_ISSOCK
accumdim
add_input_event_hook
allow_noninteger_range_as_index
and
blkmm
bug_report
cbrt
cellindexmat
chop
compare_versions
cquad
ctranspose
daspect
dbnext
do_braindead_shortcircuit_evaluation
dump_prefs
eq
erfcx
error_text
fileread
flops
fltk_backend
fltk_mouse_wheel_zoom
fminbnd
fminunc
ge
gen_doc_cache
get_first_help_sentence
get_forge_pkg
get_help_text
get_help_text_from_file
gethostname
glpkmex
gnuplot_drawnow
gt
home
isargout
isbool
isfinite
ishermitian
isindex
isocolors
isonormals
isosurface
krylovb
ldivide
le
list_in_columns
logistic_regression_derivatives
logistic_regression_likelihood
lstat
lt
matlabroot
merge
minus
missing_function_hook
mk_doc_cache
mldivide
mpower
mrdivide
mtimes
ne
nfields
not
nth_element
onCleanup
optimize_subsasgn_calls
or
pbaspect
perror
plus
polyaffine
postpad
power
powerset
ppder
ppint
ppjumps
rdivide
remove_input_event_hook
replot
reset
rsf2csf
runlength
saveimage
shell_cmd
sizemax
sphcat
spvcat
stdnormal_cdf
stdnormal_inv
stdnormal_pdf
stdnormal_rnd
strerror
svd_driver
terminal_size
texas_lotto
times
transpose
trisurf
uminus
uplus
whitebg
ylabel
ylim
zlabel
zlim

--Rik