/* * Function_Name (or phrase describing collection of functions in this file) * * Author: Your_Name(s) * with assistance from: * * Creation Date: Creation_Date * modified: Modification_Date reason * modified: Modification_Date reason * * Description of the role or purpose of this function (or collection of * functions) goes here. * (i.e., WHAT does this function do?) * * NOTE: If the file contains multiple functions, the information below * about the function declaration, input(s), output(s), and * implementation should not appear here but should be repeated for * function in the program where the function is defined.) * * return_type fcn_name (formal_parameters) * pre-condition: * post-condition: * returns: * * Input: * Describe outside input from the user or from a file. If the * formal parameter names and function pre-condition do not * adequately document the input parameters, then further * documentation should appear here. * * Output: * Describe output written to the console or to a file. If the * formal parameter names, function post-condition, and returns * clause above do not adequately document the output * (pass-by-reference) parameters and return value, then further * documentation should appear here. * * Implementation: * Describe interesting implementation details here, if any. * (HOW does this function work? What non-trivial data structures * or algorithms does it use? Does it have performance * characteristics that the user should be aware of?) * */ /* include files go here (line included below is just an example) */ #include /* function definition goes here */ return_type fcn_name (formal_parameters) { }