PHP_Beautifier
[ class tree: PHP_Beautifier ] [ index: PHP_Beautifier ] [ all elements ]

Class: PHP_Beautifier_Filter_DocBlock

Source Location: /PHP_Beautifier-0.1.15/Beautifier/Filter/DocBlock.filter.php

Class Overview

PHP_Beautifier_Filter
   |
   --PHP_Beautifier_Filter_DocBlock

Filter Doc Blocks: Use DocBlockGenerator for beautify the phpdoc comments.


Author(s):

Version:

  • Release: 0.1.15

Copyright:

  • 2010 Jesús Espino

Methods


Inherited Variables

Inherited Methods

Class: PHP_Beautifier_Filter

PHP_Beautifier_Filter::__construct()
Constructor If you need to overload this (for example, to create a definition for setting with addSettingDefinition() remember call the parent constructor.
PHP_Beautifier_Filter::addSettingDefinition()
Add a setting definition
PHP_Beautifier_Filter::getDescription()
PHP_Beautifier_Filter::getName()
return @string
PHP_Beautifier_Filter::getSetting()
Get a setting of the Filter
PHP_Beautifier_Filter::handleToken()
Function called from PHP_Beautifier::process() to process the tokens.
PHP_Beautifier_Filter::off()
Turn off the Filter Use inside the code to beautify Ex.
PHP_Beautifier_Filter::on()
Turn on the Filter Use inside the code to beautify Ex.
PHP_Beautifier_Filter::postProcess()
Called from PHP_Beautifier::process() at the end of processing
PHP_Beautifier_Filter::preProcess()
Called from PHP_Beautifier::process() at the beginning
PHP_Beautifier_Filter::setSetting()
Set a value of a Setting
PHP_Beautifier_Filter::__call()
PHP_Beautifier_Filter::__sleep()
PHP_Beautifier_Filter::__toString()

Class Details

[line 50]
Filter Doc Blocks: Use DocBlockGenerator for beautify the phpdoc comments.

Ex.

 /**
  * @category   PHP
  * @package    PHP_Beautifier
  * @subpackage Filter
  * @author     Jesús Espino 
  * @copyright  2010 Jesús Espino
  * @link       http://pear.php.net/package/PHP_Beautifier
  * @link       http://beautifyphp.sourceforge.net
  * @license    http://www.php.net/license/3_0.txt  PHP License 3.0
  * @version    Release: 0.1.15
  *'/



[ Top ]


Method Detail

t_doc_comment   [line 52]

void t_doc_comment( $sTag)

  • Access: public

Parameters:

   $sTag   — 

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:37:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.