Code covered by the BSD License  

Highlights from
mkcontnt

Be the first to rate this file! 3 Downloads (last 30 days) File Size: 4.46 KB File ID: #206

mkcontnt

by Denis Gilbert

 

08 Oct 1998 (Updated 08 Oct 2001)

Automates the generation of contents.m files

Editor's Notes:

This functionality is now available in MATLAB. Please refer to the CONTENTSRPT.M function.

| Watch this File

File Information
Description

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.

Acknowledgements
This submission has inspired the following:
MakeContents
MATLAB release MATLAB 5.2 (R10)
Tags for This File  
Everyone's Tags
Tags I've Applied
Add New Tags Please login to tag files.
Please login to add a comment or rating.
Updates

desc

Tag Activity for this File
Tag Applied By Date/Time
path Denis Gilbert 22 Oct 2008 06:33:57
directories Denis Gilbert 22 Oct 2008 06:33:57
files Denis Gilbert 22 Oct 2008 06:33:57
contentsm Denis Gilbert 22 Oct 2008 06:33:57
h1 line Denis Gilbert 22 Oct 2008 06:33:57
documentation Denis Gilbert 22 Oct 2008 06:33:57
header help lines Denis Gilbert 22 Oct 2008 06:33:57

Contact us at files@mathworks.com