You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As it stands, Documentor will include pretty much all the available info; however, incorporating more options (by means of a parameters struct input to Documentor, or a config (e.g. json) file, or...) would be useful. For instance to:
have the option of writing simplified 'user' documentation
e.g. a boolean parameter—isDetailed—is currently among the only supported options, which includes/excludes hidden methods & attributes in the printed output)
or (in the other direction) include implementation details
e.g. using codecheck to describe what internal calls to custom (or matlab) functions are made within a given piece of code
As it stands, Documentor will include pretty much all the available info; however, incorporating more options (by means of a parameters struct input to
Documentor
, or a config (e.g. json) file, or...) would be useful. For instance to:have the option of writing simplified 'user' documentation
isDetailed
—is currently among the only supported options, which includes/excludes hidden methods & attributes in the printed output)or (in the other direction) include implementation details
codetools.requiredFilesAndProducts
should be useful here—also for Enable auto-cross-referencing #14 — it's super simple (however, slow)generate an overview/table of contents file consisting of the code names and the summary header line.
Contents.m
files, or the displayed return fromlookfor
e.g. see
The text was updated successfully, but these errors were encountered: