No BSD License  

Highlights from
HyperSubFunHelp

5.0

5.0 | 1 rating Rate this file 1 Download (last 30 days) File Size: 5.04 KB File ID: #15939
image thumbnail

HyperSubFunHelp

by Mathias Ortner

 

16 Aug 2007 (Updated 20 Aug 2007)

Display expandable help of nested and subfunctions in an Mfile with recursive behavior

| Watch this File

File Information
Description

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.

Acknowledgements

The author wishes to acknowledge the following in the creation of this submission:
SubFuns

MATLAB release MATLAB 7.4 (R2007a)
Tags for This File  
Everyone's Tags
Tags I've Applied
Add New Tags Please login to tag files.
Comments and Ratings (1)
25 Feb 2009 Etienne

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

Please login to add a comment or rating.
Updates
18 Aug 2007

Added a drawnow at the beginning of display for flushing pending events.

20 Aug 2007

Corrected a bug. added a 'drawnow' for flushing pending events at the beginning of displayAll.

20 Aug 2007

Added recursive behavior.

20 Aug 2007

Added a recursive feature + fixed some bugs

20 Aug 2007

It seems there was a problem with the last submission. I hope this one will work....

Tag Activity for this File
Tag Applied By Date/Time
development environment Mathias Ortner 22 Oct 2008 09:23:04
subfunction Mathias Ortner 22 Oct 2008 09:23:04
nested function help Mathias Ortner 22 Oct 2008 09:23:04
recursive Mathias Ortner 22 Oct 2008 09:23:04
expandable Mathias Ortner 22 Oct 2008 09:23:04

Contact us at files@mathworks.com