DocBlocks are C-style comments (/** */) used by the phpDocumentor tool to create design documentation from php source code.
Header Comment Blocks
All source code files in the ea-Geier project have to contain a “page-level” DocBlock at the top of each file.
/** * A short description of the file * * A long description of file (if any)... * * * LICENSE: * 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 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 * 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., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. * * @package ea-Geier * @author Original Author <firstname.lastname@example.org> * @author Another Author <email@example.com> * @copyright 2006-2007 m2m server software gmbh * @license <a class="external free" href="http://www.gnu.org/licenses/gpl.html" rel="nofollow">http://www.gnu.org/licenses/gpl.html</a> GNU General Public License Version 2 * @version CVS: $Id:$ * @link <a class="external free" href="http://www.ea-geier.at/" rel="nofollow">http://www.ea-geier.at/</a> * @since File available since Release x.y.z * @deprecated File deprecated in Release x.y.z (if no longer used) */