You are now following this Submission
- You will see updates in your followed content feed
- You may receive emails, depending on your communication preferences
This piece of code writes a template for documenting m-files. It writes the template just after the function definition header. It finds out which are the input and output arguments (if any) and writes them down in the documentation/help section.
The script also uses Malcolm Wood's subission at
http://www.mathworks.com/matlabcentral/fileexchange/10702-exporttozip-identifies-the-dependencies-of-an-m-file-and-creates-a-zip-file
to find the dependencies of the script and annotate them into the the help section.
For instance, by introducing:
>> DocFun('DocFun', 'Guzmán Díaz')
it documents 'DocFun.m' proper.
That is, it finds the input and output arguments, the dependencies, the date, Matlab version, and leaves the rest to be completed by the author.
Because things might go terribly wrong, the script makes a copy (with extension .bak) of the original file before proceeding; which must be manually deleted if results are satisfactory.
Cite As
Guzman (2026). Documenting (help section of) an m-file (https://www.mathworks.com/matlabcentral/fileexchange/41423-documenting-help-section-of-an-m-file), MATLAB Central File Exchange. Retrieved .
Acknowledgements
Inspired by: exportToZip: Identifies the dependencies of an M-file and creates a ZIP file
Inspired: Signal Simulation, Signal with noise
General Information
- Version 1.0.0.0 (3.84 KB)
MATLAB Release Compatibility
- Compatible with any release
Platform Compatibility
- Windows
- macOS
- Linux
| Version | Published | Release Notes | Action |
|---|---|---|---|
| 1.0.0.0 |
