The .h File Template

Note:

Substrings of the form "@NAME@" should be replaced by a module-specific string.

    /* @THISFILE@:
     *
     ****************************************************************
     * Copyright (C) @YEAR@ the Free Software Foundation, Inc.
     * 
     * See the file "COPYING" for further information about
     * the copyright and warranty status of this work.
     */
    
    #ifndef @CPPGUARD@
    #define @CPPGUARD@
    
    /* Includes
     * 
     * This section should contain exactly those `#include' directives
     * needed to make this file compilable.
     * 
     * All include directives must be of the form:
     * 
     * 		#include "DIR/[....]"
     * 
     * where `DIR' is a sibling directory of `./src/tla' in a `tla'
     * source distribution.
     */
    
    /* Type Name Declarations
     * 
     * This section should declare all structure, union, and enum tags
     * declared in this header file as well as all typedefs.  Note
     * that this section must not contain any structure, union, or 
     * enum declaration (only tag declarations):
     * 
     *      struct TAG;
     *      union TAG;
     *      enum TAG;
     *      typedef ....;
     * 
     */
    
    /* Type and Macro Declarations
     * 
     * This section may be expanded to multiple pages.
     */


    
    /* automatically generated __STDC__ prototypes */
    
      /* This comment must be replaced with `extern' declarations 
       * for all exported functions defined in the corresponding
       * `.c' file.
       * 
       * This section of the header file is often AUTOMATICALLY
       * REPLACED by automatically computed declarations.
       * 
       * Therefore it is vital that this section contain 
       * no other code.
       */

    #endif  /* @CPPGUARD@ */

    
    /* arch-tag: @TAGSTR@
     */

Copyright

Copyright (C) 2004 Tom Lord

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

See the file COPYING for further information about the copyright and warranty status of this work.