PHP Docblock Generator sample output
Sample PHP code docblocks generated by PHP Docblock Generator plug-in for Coda.
Turn this:
<?php
interface alphabet {
public function getA();
public function getB();
}
abstract class Alpha {
abstract static function foo($bar, $baz, $qux);
abstract private function bar();
}
class Beta extends Alpha implements alphabet {
static var $a = true;
protected $b = array();
private $c;
static function foo($bar, $baz = 1, $qux = null) { }
private function bar();
final function _baz($qux = 'quux') { }
protected function qux() { }
public function getA() { }
public function getB() { }
}
Into this:
<?php
/**
* alphabet interface.
*/
interface alphabet {
/**
* getA function.
*
* @access public
* @return void
*/
public function getA();
/**
* getB function.
*
* @access public
* @return void
*/
public function getB();
}
/**
* Abstract Alpha class.
*
* @abstract
*/
abstract class Alpha {
/**
* foo function.
*
* @access public
* @abstract
* @static
* @param mixed $bar
* @param mixed $baz
* @param mixed $qux
* @return void
*/
abstract static function foo($bar, $baz, $qux);
/**
* bar function.
*
* @access private
* @abstract
* @return void
*/
abstract private function bar();
}
/**
* Beta class.
*
* @extends Alpha
* @implements alphabet
*/
class Beta extends Alpha implements alphabet {
/**
* a
*
* (default value: true)
*
* @var bool
* @access public
* @static
*/
static var $a = true;
/**
* b
*
* (default value: array())
*
* @var array
* @access protected
*/
protected $b = array();
/**
* c
*
* @var mixed
* @access private
*/
private $c;
/**
* foo function.
*
* @access public
* @static
* @param mixed $bar
* @param int $baz. (default: 1)
* @param mixed $qux. (default: null)
* @return void
*/
static function foo($bar, $baz = 1, $qux = null) { }
/**
* bar function.
*
* @access private
* @return void
*/
private function bar();
/**
* _baz function.
*
* @access private
* @final
* @param string $qux. (default: 'quux')
* @return void
*/
final function _baz($qux = 'quux') { }
/**
* qux function.
*
* @access protected
* @return void
*/
protected function qux() { }
/**
* getA function.
*
* @access public
* @return void
*/
public function getA() { }
/**
* getB function.
*
* @access public
* @return void
*/
public function getB() { }
}