5.1 File Headers

The standard file header to be used in any source file in the library is the following:

     /* -*- mode: C -*-
      *
      *       File:         FILE_NAME
      *       Date:         CREATION_TIME
      *
      *       GNU PDF Project - SHORT_DESCRIPTION
      *
      */

The entries in the template are:

FILE_NAME

The basename of the file.

CREATION_TIME

A time stamp string in the format:

          Fri Feb 22 21:05:05 2008

Note that if you are writing your code using Emacs then you will get the appropriate creation date running the current-time-string elisp command. If you are using the gnupdf-c-file-header skeleton template then you will get the creation date in template-expansion time.

SHORT_DESCRIPTION

A one-sentence brief description of the contents of the file. This description should not exceed one physical line of text.