API Documentation

Zend/CodeGenerator/Php/Docblock.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_CodeGenerator  
Subpackage
PHP  
Version
$Id: Docblock.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_CodeGenerator_Php_Docblock

Package: Zend\CodeGenerator

Parent(s)
\Zend_CodeGenerator_Php_Abstract < \Zend_CodeGenerator_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_indentation= ''''

Default value''Details
Type
string
Propertyprotectedstring  $_longDescription= 'null'

Default valuenullDetails
Type
string
Propertyprotectedstring  $_shortDescription= 'null'

Default valuenullDetails
Type
string
Propertyprotectedarray  $_tags= 'array()'

Default valuearray()Details
Type
array

Methods

methodprotected_docCommentize( string $content ) : string

_docCommentize()

Parameters
Name Type Description
$content string
Returns
Type Description
string
methodpublicfromReflection( \Zend_Reflection_Docblock $reflectionDocblock ) : \Zend_CodeGenerator_Php_Docblock
static

fromReflection() - Build a docblock generator object from a reflection object

Parameters
Name Type Description
$reflectionDocblock \Zend_Reflection_Docblock
Returns
Type Description
\Zend_CodeGenerator_Php_Docblock
methodpublicgenerate( ) : string

generate()

Returns
Type Description
string
methodpublicgetLongDescription( ) : string

getLongDescription()

Returns
Type Description
string
methodpublicgetShortDescription( ) : string

getShortDescription()

Returns
Type Description
string
methodpublicgetTags( ) : array

getTags

Returns
Type Description
array Array of Zend_CodeGenerator_Php_Docblock_Tag
methodpublicsetLongDescription( string $longDescription ) : \Zend_CodeGenerator_Php_Docblock

setLongDescription()

Parameters
Name Type Description
$longDescription string
Returns
Type Description
\Zend_CodeGenerator_Php_Docblock
methodpublicsetShortDescription( string $shortDescription ) : \Zend_CodeGenerator_Php_Docblock

setShortDescription()

Parameters
Name Type Description
$shortDescription string
Returns
Type Description
\Zend_CodeGenerator_Php_Docblock
methodpublicsetTag( array|\Zend_CodeGenerator_Php_Docblock_Tag $tag ) : \Zend_CodeGenerator_Php_Docblock

setTag()

Parameters
Name Type Description
$tag array|\Zend_CodeGenerator_Php_Docblock_Tag
Returns
Type Description
\Zend_CodeGenerator_Php_Docblock
methodpublicsetTags( array $tags ) : \Zend_CodeGenerator_Php_Docblock

setTags()

Parameters
Name Type Description
$tags array
Returns
Type Description
\Zend_CodeGenerator_Php_Docblock
Documentation was generated by DocBlox 0.15.1.