Differences

This shows you the differences between two versions of the page.

--- matlab:matlab_documentation_guidelines [2015/08/07 16:46] – created igorkagan
+++ matlab:matlab_documentation_guidelines [2022/12/29 07:15] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== MATLAB documentation guidelines ======
+Make sure you have most recent copy of Igtools: https://github.com/igorkagan/Igtools
+(occasionally updated at Dropbox/DAG/Sources/Igtools)
+) After opening MATLAB
+<code matlab>
+edit;
+EditorMacro('Alt-Control-h', @ig_createHeaderComment_dag);
+</code>
+Alternatively, add the above commands to [[matlab:matlab_helpful_hacks|startup.m]].
+) 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):	..., 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:
-% Author:	Yair M. Altman: altmany(at)gmail.com
-% URL:		http://www.mathworks.com/matlabcentral/fileexchange/24615-editormacro-assign-a-macro-to-a-keyboard-key-stroke-in-the-matlab-editor-and-command-window
+Yair M. Altman
-%		http://undocumentedmatlab.com/blog/editormacro-assign-a-keyboard-macro-in-the-matlab-editor
+http://www.mathworks.com/matlabcentral/fileexchange/24615-editormacro-assign-a-macro-to-a-keyboard-key-stroke-in-the-matlab-editor-and-command-window
+http://undocumentedmatlab.com/blog/editormacro-assign-a-keyboard-macro-in-the-matlab-editor