Click above to get retro games delivered to your door ever month!

           Function Header


     Each  function,  constructor,  destructor,  member  function,  or
     friend has a  header  which  comes  after  the  prototype  of the
     function  and  before  the  implementation  body.     The  header
     summarizes the function, lists and  describes  the  parameters to
     the function, describes the return value, describes  the internal
     workings of the  function,  and lists remarks about side effects,
     assumptions, and general warnings and  cautions.  The format of a
     function header is given below.

     // Function // (or Member Function, Constructor, etc.)

     function prototype

     // Summary -------------------------------------------------
     //
     //        A brief summary of the function.
     //
     // Parameters
     //
     //        A description of each of the parameters to the
     //        function and how they are used.
     //
     // Return Value
     //
     //        A description of the value returned to the
     //        function's caller.
     //
     // Functional Description
     //
     //        A description of the overall flow and operation
     //        of the function.
     //
     // Remarks
     //
     //        A list of side effects, assumptions, warnings,
     //        and cautions.
     //
     // End -----------------------------------------------------