CodeGenerator/Php/Docblock.php
Show:
inherited
inherited
Classes
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
string $_indentation = ''Default value
''Details- Type
- string
string $_longDescription = nullDefault value
nullDetails- Type
- string
string $_shortDescription = nullDefault value
nullDetails- Type
- string
array $_tags = array()Default value
array()Details- Type
- array
Methods
_docCommentize(string $content) : string_docCommentize()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $content | string |
| Type | Description |
|---|---|
| string |
fromReflection(\Zend_Reflection_Docblock $reflectionDocblock) : \Zend_CodeGenerator_Php_Docblockstatic
fromReflection() - Build a docblock generator object from a reflection object
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $reflectionDocblock | \Zend_Reflection_Docblock |
| Type | Description |
|---|---|
| \Zend_CodeGenerator_Php_Docblock |
generate() : stringgenerate()
Returns
| Type | Description |
|---|---|
| string |
getLongDescription() : stringgetLongDescription()
Returns
| Type | Description |
|---|---|
| string |
getShortDescription() : stringgetShortDescription()
Returns
| Type | Description |
|---|---|
| string |
getTags() : arraygetTags
Returns
| Type | Description |
|---|---|
| array | Array of Zend_CodeGenerator_Php_Docblock_Tag |
setLongDescription(string $longDescription) : \Zend_CodeGenerator_Php_DocblocksetLongDescription()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $longDescription | string |
| Type | Description |
|---|---|
| \Zend_CodeGenerator_Php_Docblock |
setShortDescription(string $shortDescription) : \Zend_CodeGenerator_Php_DocblocksetShortDescription()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $shortDescription | string |
| Type | Description |
|---|---|
| \Zend_CodeGenerator_Php_Docblock |
setTag(array | \Zend_CodeGenerator_Php_Docblock_Tag $tag) : \Zend_CodeGenerator_Php_DocblocksetTag()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $tag | array | \Zend_CodeGenerator_Php_Docblock_Tag |
| Type | Description |
|---|---|
| \Zend_CodeGenerator_Php_Docblock |
setTags(array $tags) : \Zend_CodeGenerator_Php_DocblocksetTags()
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $tags | array |
| Type | Description |
|---|---|
| \Zend_CodeGenerator_Php_Docblock |