Home » PHP » PHP_DocBlockGenerator

DocBlock Generator

This package is unmaintained.

Download latest release 1.1.2 (archived versions might be outdated)

License: The BSD License

Description

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%.

Maintainers

• Michel Corne (mcorne) — lead, active
• Daniel Convissor (danielc) — helper, inactive

Dependencies

Required

• PHP (>= 5.0)
• PEAR Installer (>= 1.4.0)
• Console_Getopt
• PHP_CompatInfo

Releases

• 1.1.2 (stable, 2011-12-11)
  Release notes

  License: The BSD License

  * Request 14162: Want to use other licenses.
  * Bug 15490: Eliminate var_export() output from PHP_CompatInfo.
  * Bug 16181: Ordering issues.
  * Bug 16193: Expected 1 space before variable type.
  * Bug 18980: Get test suite working again.

• 1.1.1 (stable, 2007-09-13)
  Release notes

  License: The BSD License

  * Fixed Bug #11984: static protected $variable noted correctly detected

• 1.1.0 (stable, 2007-07-23)
  Release notes

  License: The BSD License

  * Added enhancement request Bug #11663: implementation for 'interface'
  * Added functionality to process abstract class/function
  * Fixed generation of class version tag: @package_version@
  * Fixed BSD license text to comply with the 85 character limit per line

• 1.0.2 (stable, 2007-07-19)
  Release notes

  License: The BSD License

  * Fixed Bug #11622: static private function and final class not correctly detected
  * Fixed Bug #11575: "bad interpreter" error on linux, @php_bin@ enclosed in double-quotes
  * Fixed tests to run for non PEAR install
  * Changed tests to keep generated files to make debugging easier

• 1.0.1 (stable, 2007-07-07)
  Release notes

  License: The BSD License

  * Changed the AllTests main class name to comply with the QA PEAR-wide unit test

• 1.0.0 (stable, 2007-07-06)
  Release notes

  License: The BSD License

  * Initial stable release
  * Fixed regression on -A option

• 1.0.0RC1 (beta, 2007-06-29)
  Release notes

  License: The BSD License

  * Initial PEAR release
  * Testing with PHPUnit
  * Using PHPCompat to determine the PHP version
  * Using Consol_Getopt for the CLI
  * Various fixes and enhancements

Bugs