/****** TEMPLATE FOR C PROGRAMMING -- header file ***************/ /******************************************************** * Name -- Short one line description of the module * * * * Description: * * Much longer description of the module. * * Also describe what it provides. * * * * Design: * * Information on the design of the code below. * * * * References: * * List of references that are useful to us. * * * * (This comment block can be copied from the * * module itself.) * ********************************************************/ #ifndef _MODULE_H_INC_ /* Protect against double includes */ #define _MODULE_H_INC_ /******************************************************** * funct_name -- One line description of the function * * * * Multi-line description of what the function does. * * * * Memory usage: * * Indicate if the function allocates memory * * and if so, how the memory is to be disposed of. * * * * If the function disposes of memory, indicate * * who you expect to have allocated it. * * * * Returns: * * What does the function return. * ********************************************************/ extern int16 funct_name( const int32 param1, // Description of the first parameter const int32 param2 // Description of the second parameter ) #endif /* _MODULE_H_INC_ */