Editor's Note: This functionality is now available in MATLAB. Please refer to the CONTENTSRPT.M function.
Do you find Matlab's contents.m files useful? Would you like to be able to easily generate contents.m files based on your own Matlab
programming? MKCONTNT will help you document your work while taking advantage of subtle features of the helpdesk.
In a directory containing your own m-files, it will open all m-files present in the directory, look for the first line with a '%' character, and assume that this line is the H1 line (first commented line). If a version of contents.m already exists in your directory, it makes a backup copy of it prior to creating the new contents.m file.
There are two caveats to be aware of: 1) no fancy editing is done, the H1 lines are copied exactly as they appear in the original m-files; 2) the users must develop the habit of writing informative H1 lines at the beginning of their m-files.
Denis Gilbert (2021). mkcontnt (https://www.mathworks.com/matlabcentral/fileexchange/206-mkcontnt), MATLAB Central File Exchange. Retrieved .
MATLAB Release Compatibility
Platform CompatibilityWindows macOS Linux
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!Start Hunting!