Home > freetb4matlab > help > gen_doc_cache.m

gen_doc_cache

PURPOSE ^

% Generate documentation caches for all functions in a given directory.

SYNOPSIS ^

function gen_doc_cache (out_file = 'doc-cache', directory = [])

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} gen_doc_cache (@var{out_file}, @var{directory})
% Generate documentation caches for all functions in a given directory.
%
% A documentation cache is generated for all functions in @var{directory}.  The
% resulting cache is saved in the file @var{out_file}.
% The cache is used to speed up @code{lookfor}.
%
% If no directory is given (or it is the empty matrix), a cache for builtin
% operators, etc. is generated.
%
% @seealso{lookfor, path}
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003