                           File Header Lines
------------------------------> cut here <-------------------------------------
//  File: xxx.h  Facility: xxx  Class: Xxxx
//  One line summary of file content here.
------------------------------> cut here <-------------------------------------


                 Facility Prolog (at start of public .h file)
------------------------------> cut here <-------------------------------------
//*********************************************************************
//
//  FACILITY:  Facility Name (FN)
//
//  ABSTRACT:
//      A one or two paragraph abstract of this facility and its role
//      in the product go here.
//
//  ASSOCIATED SOURCE CODE FILES:
//      xxx1.cpp        summary of implementation file
//      xxx2.cpp        summary of implementation file
//
//  REENTRANCY: thread safe
//
//  RESTRICTIONS: none
//
//  AUTHORS:
//      you name(s) listed here
//
//  ADDITIONAL INFORMATION:
//      Additional information that would help the *user* of this
//      facility (NOT implementation info!).
//
//      This could be just a few notes, or it could be pages of
//      diagrams, explanations, etc.
//
//*********************************************************************
------------------------------> cut here <-------------------------------------


                    Module Prolog (at start of .cpp file)
------------------------------> cut here <-------------------------------------
//*********************************************************************
//
//  MODULE NAME:  xxxxxx.cpp
//
//  MODULE ABSTRACT:
//      Implementation file for the Xxxxx class.
//
//  AUTHORS:
//      your name(s)
//
//  PORTABILITY CONSTRAINTS:
//      none
//
//  DESIGN ISSUES:
//      Describe internal (implementation) design issues/information.
//
//*********************************************************************
------------------------------> cut here <-------------------------------------


                    Class Prolog (place before class declaration)
------------------------------> cut here <-------------------------------------
//*********************************************************************
//
//  CLASS NAME:  SomeClass
//
//  DESCRIPTION:
//      A general description of the class.
//
//  INHERITS FROM:  SuperClass
//
//  USES:
//      Used Class     Card     Description
//      xxxx           0-n      Contains zero or more xxx objects
//
//*********************************************************************
------------------------------> cut here <-------------------------------------


                Object Method Public Prolog & Declaration (in .h)
------------------------------> cut here <-------------------------------------
   //******************************************************************
   //
   //  FUNCTION NAME:  someMethod
   //
   //  DESCRIPTION:
   //      Description of the method.
   //
   //  SIDE EFFECTS:
   //      none
   //
   //******************************************************************
   StatusCode someMethod(
      AttributeSet*       inp_as,   // Description of first parameter,
                                    //   continued on multiple lines
                                    //   if needed.
      Oid&                outr_oid  // Description of next parameter
      );
------------------------------> cut here <-------------------------------------


               Object Method Implementation Prolog (in .cpp)
------------------------------> cut here <-------------------------------------
   //******************************************************************
   //
   //  FUNCTION NAME:  someMethod
   //
   //  DESCRIPTION:
   //      Description of design/implementation of this method.
   //      (Don't repeat stuff from .h prolog!)
   //
   //******************************************************************
   StatusCode someMethod(
      AttributeSet*       inp_as,   // Description of first parameter,
                                    //   continued on multiple lines
                                    //   if needed.
      Oid&                outr_oid  // Description of next parameter
      );
------------------------------> cut here <-------------------------------------


                     Revision History (place at END of file)
------------------------------> cut here <-------------------------------------

//  REVISION HISTORY:
//
//    Version      Date     Time    Owner   Comment
// ------------- -------- -------- -------- ----------------------------
// Vxxxxxxxx     mm/dd/93 hh:mm:ss userid   description
------------------------------> cut here <-------------------------------------
# V1.2.1.1      11/15/93 08:33:56 hlava    New Revision History format
