Page Header Block

From ARK
Jump to: navigation, search

The page header block should be included at the top of ever new php file. It is exactly as specified in the PEAR standard. This will allow the API to be documented automagically using phpdocumenter.

The block should be as follows:

/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */

* filter_functions.php
* holds filter functions
* PHP versions 4 and 5
*    ARK - The Archaeological Recording Kit.
*    An open-source framework for displaying and working with 
*    archaeological data
*    Copyright  2007  L - P : Partnership Ltd.
*    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 3 of the License, 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
*    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, see <>.
* @category   base
* @package    ark
* @author     Stuart Eve <>
* @author     Guy Hunt <>
* @copyright  1999-2007 L - P : Partnership Ltd.
* @license
* @version    CVS: :
* @link TO FILE
* @since      File available since Release 0.5