CodeGenerator/Php/Docblock.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_CodeGenerator  
Subpackage
PHP  
Version
$Id$  

\Zend_CodeGenerator_Php_Docblock

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

Properties

>VPropertyprotectedstring $_indentation = ''
Default value''Details
Type
string
>VPropertyprotectedstring $_longDescription = null
Default valuenullDetails
Type
string
>VPropertyprotectedstring $_shortDescription = null
Default valuenullDetails
Type
string
>VPropertyprotectedarray $_tags = array()
Default valuearray()Details
Type
array

Methods

methodprotected_docCommentize(string $content) : string

_docCommentize()

Parameters
NameTypeDescription
$contentstring
Returns
TypeDescription
string
methodpublicfromReflection(\Zend_Reflection_Docblock $reflectionDocblock) : \Zend_CodeGenerator_Php_Docblock
static

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

Parameters
NameTypeDescription
$reflectionDocblock\Zend_Reflection_Docblock
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicgenerate() : string

generate()

Returns
TypeDescription
string
methodpublicgetLongDescription() : string

getLongDescription()

Returns
TypeDescription
string
methodpublicgetShortDescription() : string

getShortDescription()

Returns
TypeDescription
string
methodpublicgetTags() : array

getTags

Returns
TypeDescription
arrayArray of Zend_CodeGenerator_Php_Docblock_Tag
methodpublicsetLongDescription(string $longDescription) : \Zend_CodeGenerator_Php_Docblock

setLongDescription()

Parameters
NameTypeDescription
$longDescriptionstring
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicsetShortDescription(string $shortDescription) : \Zend_CodeGenerator_Php_Docblock

setShortDescription()

Parameters
NameTypeDescription
$shortDescriptionstring
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicsetTag(array | \Zend_CodeGenerator_Php_Docblock_Tag $tag) : \Zend_CodeGenerator_Php_Docblock

setTag()

Parameters
NameTypeDescription
$tagarray | \Zend_CodeGenerator_Php_Docblock_Tag
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
methodpublicsetTags(array $tags) : \Zend_CodeGenerator_Php_Docblock

setTags()

Parameters
NameTypeDescription
$tagsarray
Returns
TypeDescription
\Zend_CodeGenerator_Php_Docblock
Documentation was generated by phpDocumentor 2.2.0 .