comparison scripts/help/gen_doc_cache.m @ 10793:be55736a0783

Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents 1bf0ce0930be
children 2c356a35d7f5
comparison
equal deleted inserted replaced
10792:91342260063e 10793:be55736a0783
16 16
17 ## -*- texinfo -*- 17 ## -*- texinfo -*-
18 ## @deftypefn {Function File} gen_doc_cache (@var{out_file}, @var{directory}) 18 ## @deftypefn {Function File} gen_doc_cache (@var{out_file}, @var{directory})
19 ## Generate documentation caches for all functions in a given directory. 19 ## Generate documentation caches for all functions in a given directory.
20 ## 20 ##
21 ## A documentation cache is generated for all functions in @var{directory}. The 21 ## A documentation cache is generated for all functions in @var{directory}.
22 ## The
22 ## resulting cache is saved in the file @var{out_file}. 23 ## resulting cache is saved in the file @var{out_file}.
23 ## The cache is used to speed up @code{lookfor}. 24 ## The cache is used to speed up @code{lookfor}.
24 ## 25 ##
25 ## If no directory is given (or it is the empty matrix), a cache for builtin 26 ## If no directory is given (or it is the empty matrix), a cache for builtin
26 ## operators, etc. is generated. 27 ## operators, etc. is generated.