File: DocBlockGenerator.php
Source Location: /PHP_DocBlockGenerator-1.1.2/PHP/DocBlockGenerator.php
Classes:
PHP_DocBlockGenerator
Creation of Documentation blocks or DocBlocks in a PHP file
Page Details:
DocBlock Generator
Creates the file Page block and the DocBlocks for includes, global variables, functions, parameters, classes, constants, properties and methods. Accepts parameters to set the category name, the package name, the author's name and email, the license, the package link, etc... Attempts to guess variable and parameters types. Aligns the DocBlock tags. Tags are not updated or added to existing DocBlocks but only realigned. The package can be run by: calling the "PHP_DocBlockGenerator" class, or by running the "docblockgen" DOS/Unix command. Fully tested with phpUnit. Code coverage test close to 100%. PHP version 5 All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer. - Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - The names of its contributors may not be used to endorse or
promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Includes:
require_once('PHP/DocBlockGenerator/Tokens.php') [line 55]
Documentation generated on Mon, 11 Mar 2019 15:46:45 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
