CS 5320
Fall Semester 2009

 
Programming Documentation

 
Every Matlab function must be documented with the following information in this format at the head of the function:

% CV_<name> - <short description of function>
% Call:
%     <Example of calling sequence; take from line 1>
% On input:
%     <parameter 1>: <description of parameter 1>
%     <parameter 2>: <description of parameter 2>
%            ...
%     <parameter m>: <description of parameter m>
% On output:
%     <parameter 1>: <description of parameter 1>
%     <parameter 2>: <description of parameter 2>
%            ...
%     <parameter n>: <description of parameter n>
% Custom Functions Used:
%     <list of functions> | none
% Author:
%     <Name>
%     <Date>
% Method
%     <Short description of method>
% Testing
%     <example usage with simple in and out parameters; or pointer to testing files>
%

Example:

function pts = CV_rect_pts(side_x, side_y, step_x, step_y)
%
% CV_rect_pts - generate sample points on rectangle in plane
% Call:
%     pts = CV_rect_pts(sode_x, side_y, step_x, step_x);
% On input:
%     side_x: length of side in x direction
%     side_y: length of side in y direction
%     step_x: x distance between sample points
%     step_y: y distance between sample points
% On output:
%     pts: set of sample points/normals in rectangle; n by 6 matrix (x,y,z,a,b,c)
% Author:
%     Tom Henderson
%     7 January 2000
% Custom Functions Used:
%     none
% Method:
%     Generate all points in rectangle defined by x domain (-side_x/2,side_x/2)
% and y domain (-side_y/2,side_y/2) about origin.  The normal vector is in z-axis
% direction.
% Testing:
% >> pts = CV_rect_pts(2,2,1,1)
%
% pts =
%
%      -1    -1     0     0     0     1
%      -1      0     0     0     0     1
%      -1      1     0     0     0     1
%        0    -1     0     0     0     1
%        0      0     0     0     0     1
%        0      1     0     0     0     1
%        1    -1     0     0     0     1
%        1      0     0     0     0     1
%        1      1     0     0     0     1
%
%  >>
%