User Tools

Site Tools


matlab:matlab_documentation_guidelines

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
matlab:matlab_documentation_guidelines [2015/08/07 16:49] igorkaganmatlab:matlab_documentation_guidelines [2022/12/29 07:15] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== MATLAB documentation guidelines ====== ====== MATLAB documentation guidelines ======
  
-Make sure you have most recent copy of Igtools (Dropbox/DAG/Sources/Igtools)+Make sure you have most recent copy of Igtools: https://github.com/igorkagan/Igtools  
 +(occasionally updated at Dropbox/DAG/Sources/Igtools) 
  
 1) After opening MATLAB 1) After opening MATLAB
  
->EditorMacro('Alt-Control-h', @createHeaderComment_dag);+<code matlab> 
 +edit; 
 +EditorMacro('Alt-Control-h', @ig_createHeaderComment_dag);  
 +</code>
  
-Alternatively, add the above command to startup.m+Alternatively, add the above commands to [[matlab:matlab_helpful_hacks|startup.m]].
  
 2) PRESS Alt-Control-h while in MATLAB Editor (new or existing file) 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): ..., 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>
  
 ---- ----
matlab/matlab_documentation_guidelines.1438966174.txt.gz · Last modified: 2022/12/29 07:15 (external edit)