File Exchange

image thumbnail

HyperSubFunHelp

version 1.0.0.0 (5.04 KB) by Mathias Ortner
Display expandable help of nested and subfunctions in an Mfile with recursive behavior

1 Download

Updated 20 Aug 2007

No License

HYPERSUBFUNHELP displays help of a file with expandable recursive subfunctions help
HYPERSUBFUNHELP(MFILE) displays the help of MFILE with expandable help
for each nested/sub functions that are preceeded by a line of comment
containing the key expression '% Display Help'

A set of links is generated containing the name of a sub functions and a
the h1 line of every subfunction.

The expension of one link results in the following displays:
- a link for retracting the subfunction help,
- the subfunction help,
- links for expanding subfunctions of the current subfunction are
displayed (recursive behavior) provided that the subfunctions are
preceeded by a '% Display Help' Tag.

HYPERSUBFUNHELP(MFILE,'short') does not display the main help.
It is usefull for including a link in an Mfile help that adds links to
subfunction help beneath the main help, without repeating it.

Note 1: The depth parsing of subfunctions is based on the indentation
(spaces). If the mfile is not properly indented, the function might not
work.

Cite As

Mathias Ortner (2021). HyperSubFunHelp (https://www.mathworks.com/matlabcentral/fileexchange/15939-hypersubfunhelp), MATLAB Central File Exchange. Retrieved .

Comments and Ratings (1)

Etienne

Bon boulot, je l'utilise tout au long de ma thèse

MATLAB Release Compatibility
Created with R2007a
Compatible with any release
Platform Compatibility
Windows macOS Linux
Acknowledgements

Inspired by: SubFuns

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!