fcnname is a function, whether an m-file or a compiled one, a function inside a package as 'pkg.fcnname', or a method of an old-style class as '@cls/method', each spelled the way help takes it. Its entry is written into the doc-cache of the current directory, leaving every other entry in that file alone. The file must live here, or in a +pkg or @class directory below, neither of which can hold a cache of its own.

A name that no longer resolves is treated as removed and its entry dropped, which is how a deleted or renamed function is cleared out of the cache it still sits in.

A compiled function is read from its .oct, which must exist and be newer than its .cc, since that is the only place a DEFUN_DLD docstring lives.

For a class, use classdef_texi2cache, which writes the class and all of its members together.

options is a pkg_doc_options object. Its IndexLocation property never decides what is written here: the function named is always cached, and an INDEX given only adds a warning when the function is not listed in it.

The help text is read from the file rather than from the session: clear functions is issued first, and what the interpreter then answers must carry a distinctive run of the docstring in the file, so that neither a definition held from earlier nor a copy installed elsewhere can be cached unnoticed.

report is a struct with the fields 'cache', 'added', 'updated', 'removed', 'changed' and 'findings'. With no output requested the same information is printed.

See also: package_texi2cache, folder_texi2cache, classdef_texi2cache, function_texi2html, pkg_doc_options

Source Code: function_texi2cache