Before the declaration of any class, include the following Code Documentation Block - DocBlock and insert the appropriate values

/**
 * Class Name/short description
 *
 * Long description
 *
 * @package 
 * @subpackage 
 */

Here is an example from class/icms.htmlpurifier.php

/**
 * Class to Clean & Filter HTML for various uses.
 *
 * Class uses external HTML Purifier for filtering.
 *
 * @package	kernel
 * @subpackage	core
 *
 * @author	vaughan montgomery ([email protected])
 * @author      ImpressCMS Project
 * @copyright	(c) 2007-2008 The ImpressCMS Project - www.impresscms.org
 **/

For other code elements, see Documenting Code Elements Category: Getting Started Category: Development Category: Documentation <[Languages |Class Code Documentation Block - DocBlock]>

Last modified on 2010/11/25 by Anonymous
Comments
The comments are owned by the poster. We aren't responsible for their content.