image thumbnail

Create_help_files

version 1.0.0.0 (3.52 KB) by Mark Jobse
Create special contents.m files or a summary of all m-files.

1.4K Downloads

Updated 25 Jul 2002

No License

For those who don't know: in MATLAB a contents.m file is used by the help command. "help dir" will show the contents of the contents.m file. If no file exists, the H1 line in the m-files is used.

I wanted a little more info, so these functions read the entire Help-text in the m-files (the part before the body). Those are then written in a contents.m file. If one already exists, it is overwritten. This is done for the entire path under the specified directory. Instead of creating a contents file in every dir, a summary.txt can be created. This is the same as above, but contains all help-texts in one file.

The function that does all this is called 'create_help_files'. It needs 2 arguments:

1)string, the dir
2) integer, option:
1->create contents files
2->create summary.

If you want the entire m-file instead of just the summaries, use 'collectcode' by Brett Shoelson. Also available on this website.

Cite As

Mark Jobse (2021). Create_help_files (https://www.mathworks.com/matlabcentral/fileexchange/2047-create_help_files), MATLAB Central File Exchange. Retrieved .

MATLAB Release Compatibility
Created with R12.1
Compatible with any release
Platform Compatibility
Windows macOS Linux

Community Treasure Hunt

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

Start Hunting!