InsertHeader

Inserts a user defined header in the m file currently open in editor

Description

% InsertHeader Adds a template to the top of current file in editor for documentation.
% InsertHeader('filename')

% Example
% InsertHeader('InsertHeader') added the current header information to this
% file. NOTE: THIS CANNOT BE UNDONE! THE FIRST TIME YOU USE THIS, PLEASE
% HAVE A BACK UP COPY OF THE FILE IN CASE IT MAKES A MISTAKE.
% Custom defined headers can be created in the subfunction defined at
% the end of the file. I wish to express thanks to the authors of tedit.m and
% newfcn.m which helped me to create this routine.
% See also: tedit, newfcn

The manner in which I use it is to define a shortcut with the command InsertHeader(). That way when I click the shortcut my header is automatically inserted into whichever file is on top.

Note: If you use keyword expansion with your source control software, it will replace the strings in your template, if you check this file in... so plan on correcting the text before you use it.

This function does perform calls to Java commands which are not part of the normal documentation.

Acknowledgements

The author wishes to acknowledge the following in the creation of this submission:
NEWFCN, TEDIT

• MATLAB release: MATLAB 7.13 (2011b)
• Other requirements: I haven't tested it, but this will probably not work without java

[Carlos Adrian Vargas Aguilera]

This is a nice function DAN. Why don't you extract thos little but useful (to me :)) subfunction you use like the one to look for the current file, others to save the file, toget the list of the opened files, etc?

Carlos

[Andre Guy Tranquille]

 

[K E]

Very useful function, but has stopped working when I switched to R2011a. Generates some java errors.

[Dan K]

KE,
 I've updated the code to work again with R2011b. Let me know if there are any issues.
Dan