This is an old revision of the document!
MATLAB documentation guidelines
Make sure you have most recent copy of Igtools (Dropbox/DAG/Sources/Igtools)
1) After opening MATLAB
EditorMacro('Alt-Control-h', @createHeaderComment_dag);
Alternatively, add the above command to startup.m
2) PRESS Alt-Control-h while in MATLAB Editor (new or existing file)
This will add documentation template:
<code matlab> function … = …(…) %functionname - one line function description % % USAGE: % usage example1; % usage example2; % … % % INPUTS: % input 1 - exlanation % … % % OUTPUTS: % output1 - explanation % … % % REQUIRES: … % % See also … % % % Author(s): I.Kagan, DAG, DPZ % URL: http://www.dpz.eu/dag % % Change log: % yyyymmdd: Created function (Author(s) firstname familyname) % … % $Revision: 1.0 $ $Date: 2015-08-07 18:27:53 $
% ADDITIONAL INFO: % … %[DAG mfile header version 1]% <code>
Thanks to:
Yair M. Altman
http://undocumentedmatlab.com/blog/editormacro-assign-a-keyboard-macro-in-the-matlab-editor