posix/include/psx/template.h

   1 /* $Id: template.h,v 1.4 2002/03/10 18:06:08 hyperion Exp $
   2  How to create a new header file from this template:
   3   - copy the template in the new file (never edit this file directly, unless
   4     that's what you want)
   5   - search for the string "EDITME" in the file, and follow the instructions
   6   - remove this comment block, all blocks containing REMOVEME, and all EDITME
   7     instructions
   8   - save your file, and Have Fun! (TM)
   9  */
  10 /* $*Id*$ (EDITME: remove asterisks from "$*Id*$")
  11  */
  12 /*
  13  * psx/template.h (EDITME: replace with the real name of the header)
  14  *
  15  * template for POSIX headers (EDITME: replace this line with the real file
  16  * description)
  17  *
  18  * This file is part of the ReactOS Operating System.
  19  *
  20  * Contributors:
  21  *  Created by John Doe <john.doe@mail.com> (EDITME: your name and e-mail go
  22  *  here)
  23  *
  24  *  THIS SOFTWARE IS NOT COPYRIGHTED
  25  *
  26  *  This source code is offered for use in the public domain. You may
  27  *  use, modify or distribute it freely.
  28  *
  29  *  This code is distributed in the hope that it will be useful but
  30  *  WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  31  *  DISCLAMED. This includes but is not limited to warranties of
  32  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  33  *
  34  */
  35
  36 /*
  37  Tags are used to prevent double inclusion of C header files. This
  38  technique should be documented in all good C manuals
  39
  40  How to generate an unique tag for your header:
  41   - uppercase the name of the header, where "name" is the filename and
  42     the optional relative path (e.g. "stdio.h", "sys/types.h")
  43   - replace all non-alphanumeric characters in the obtained name with an
  44     underscore character ("_")
  45   - prepend a double underscore ("__"), and append the string "_INCLUDED__"
  46   - replace all occurrences of "__PSX_TEMPLATE_H_INCLUDED__" in this file
  47     with your tag
  48
  49  Example tags:
  50   sys/types.h -> SYS/TYPES.H -> SYS_TYPES_H -> __SYS_TYPES_H_INCLUDED__
  51   iso646.h -> ISO646.H -> ISO646_H -> __ISO646_H_INCLUDED__
  52
  53  (REMOVEME)
  54  */
  55 #ifndef __PSX_TEMPLATE_H_INCLUDED__ /* EDITME: replace macro with unique tag */
  56 #define __PSX_TEMPLATE_H_INCLUDED__ /* EDITME: replace macro with unique tag */
  57 /*
  58  Explanation of the sections:
  59   INCLUDES   #include directives should be grouped here
  60   OBJECTS    declare global variables here
  61   TYPES      types, structures and unions here
  62   CONSTANTS  symbolic constants (simple #define's), enums, constants
  63   PROTOTYPES ANSI C function prototypes
  64   MACROS     parametrized macros
  65
  66  (REMOVEME)
  67  */
  68 /* INCLUDES */
  69
  70 /* OBJECTS */
  71
  72 /* TYPES */
  73
  74 /* CONSTANTS */
  75
  76 /* PROTOTYPES */
  77
  78 /* MACROS */
  79
  80 #endif /* __PSX_TEMPLATE_H_INCLUDED__ */ /* EDITME: replace macro with unique tag */
  81
  82 /* EOF */
  83