% PROTOTYPE % give the function prototype. % % USAGE EXAMPLE(S) % give as many usage examples and details as possible. % % GENERAL DESCRIPTION % describe the functionality that our code covers. % % REFERENCES % list all the relevant references related to the implemented functionality. % % INPUTS: % input1 - description % input2 - description, etc. % % OUTPUTS: % output1 - description % output2 - description, etc. % % NOTES / COMMENTS % * note 1 text. % % ** note 2 text, etc. % it would be a good practice to give as much details as possible about your development % environment, e.g. "Matlab version 6.5" or "compiled using gcc ver. 3.2.1.". % % REVISION HISTORY % version x.y, reference to previous versions of this code. % % RELATED FUNCTIONS (SEE ALSO) % list the functions that this code uses (for Matlab, list only the functions/scripts % that are not part of the standard Matlab package. % % ABOUT % Created: date % Last Update: date % Revision: x.y % % AUTHOR: name, surname, affiliation % mailto: xxx@yyy.com % URL: your homepage % % WHEN PUBLISHING A PAPER AS A RESULT OF RESEARCH CONDUCTED BY USING THIS CODE % OR ANY PART OF IT, MAKE A REFERENCE TO THE FOLLOWING PAPER: % name the paper you would like to be cited by others when using your code. % the paper to be cited must be related to the code given (e.g. you developed % a new filtering method and published a paper about it and by using the implementation % given here others can compare their results to your method). %