Create_help_files

Create special contents.m files or a summary of all m-files.

Al momento, stai seguendo questo contributo

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.

Cita come

Mark Jobse (2026). Create_help_files (https://it.mathworks.com/matlabcentral/fileexchange/2047-create_help_files), MATLAB Central File Exchange. Recuperato .

Categorie

Scopri di più su Share and Distribute Software in Help Center e MATLAB Answers

Informazioni generali

Compatibilità della release di MATLAB

  • Compatibile con qualsiasi release

Compatibilità della piattaforma

  • Windows
  • macOS
  • Linux
Versione Pubblicato Note della release Action
1.0.0.0