clsname is a class, qualified by its package when it lives in one, as in 'prob.NormalDistribution'. Its own entry and one per member are written into the doc-cache of the current directory, and the entries the class no longer has are dropped, so a method renamed inside a class needs only the class named once.

The class file must live in the current directory, or in a +pkg directory below it. A +pkg directory is never itself the place to stand: a cache inside one can be read by nothing, so a namespaced class is written from the directory holding the +pkg.

The members are the ones the class documents: its public constructor, the methods declared in the class’s own file, and the properties reported by properties, inherited ones included. This is what classdef_texi2html publishes, so a class reads the same way online and in lookfor, and it is not an arbitrary choice: help resolves an inherited property on a subclass but not an inherited method, so these are exactly the members a cache entry can be built for. Members of a Hidden or private block are left out, as are those carrying no texinfo help, each of the latter reported under MissingDocstring as it is skipped.

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

An inherited property is cached, its help text belonging to the superclass that declares it, but only the rules a renderer can apply are run on it: the rules that measure a file are left to the run that covers the file it is written in.

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, function_texi2cache, classdef_texi2html, pkg_doc_options

Source Code: classdef_texi2cache