from
M-file Header Template
by Denis Gilbert
Promotes better m-file documentation by encouraging authors to produce informative headers.
|
| function_name(input1,input2,input3)
|
function [output1,output2] = function_name(input1,input2,input3)
%FUNCTION_NAME - One line description of what the function or script performs (H1 line)
%Optional file header info (to give more details about the function than in the H1 line)
%Optional file header info (to give more details about the function than in the H1 line)
%Optional file header info (to give more details about the function than in the H1 line)
%
% Syntax: [output1,output2] = function_name(input1,input2,input3)
%
% Inputs:
% input1 - Description
% input2 - Description
% input3 - Description
%
% Outputs:
% output1 - Description
% output2 - Description
%
% Example:
% Line 1 of example
% Line 2 of example
% Line 3 of example
%
% Other m-files required: none
% Subfunctions: none
% MAT-files required: none
%
% See also: OTHER_FUNCTION_NAME1, OTHER_FUNCTION_NAME2
% Author: Denis Gilbert, Ph.D., physical oceanography
% Maurice Lamontagne Institute, Dept. of Fisheries and Oceans Canada
% email address: gilbertd@dfo-mpo.gc.ca
% Website: http://www.qc.dfo-mpo.gc.ca/iml/
% December 1999; Last revision: 12-May-2004
%------------- BEGIN CODE --------------
Enter your executable matlab commands here
%------------- END OF CODE --------------
|
|
Contact us at files@mathworks.com