CodeGenerator/Php/Docblock.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_CodeGenerator
subpackage: PHP
version: $Id: Docblock.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_CodeGenerator_Php_Docblock

Description

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.

Zend_CodeGenerator_Php_Docblock
jump to top

Extends from: Zend_CodeGenerator_Php_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_CodeGenerator
Properties: $_shortDescription; $_longDescription; $_tags; $_indentation
Methods: fromReflection; setShortDescription; getShortDescription; setLongDescription; getLongDescription; setTags; setTag; getTags; generate; _docCommentize

Description

Properties

$_indentation
jump to class

string $_indentation = ''

Details

$_indentation: string
visibility: protected
default
final: false
static: false

$_longDescription
jump to class

string $_longDescription = 'null'

Details

$_longDescription: string
visibility: protected
default: null
final: false
static: false

$_shortDescription
jump to class

string $_shortDescription = 'null'

Details

$_shortDescription: string
visibility: protected
default: null
final: false
static: false

$_tags
jump to class

array $_tags = 'array'

Details

$_tags: array
visibility: protected
default: array
final: false
static: false

Methods

_docCommentize
jump to class

_docCommentize(
          string $content
          )
        
        :
        string

_docCommentize()

Arguments

$content: string

Output

string

Details

visibility: protected
final: false
static: false

fromReflection
jump to class

fromReflection(
          Zend_Reflection_Docblock $reflectionDocblock
          )
        
        :
        Zend_CodeGenerator_Php_Docblock

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

Arguments

$reflectionDocblock: Zend_Reflection_Docblock

Output

Zend_CodeGenerator_Php_Docblock

Details

visibility: public
final: false
static: true

generate
jump to class

generate(
          
          )
        
        :
        string

generate()

Output

string

Details

visibility: public
final: false
static: false

getLongDescription
jump to class

getLongDescription(
          
          )
        
        :
        string

getLongDescription()

Output

string

Details

visibility: public
final: false
static: false

getShortDescription
jump to class

getShortDescription(
          
          )
        
        :
        string

getShortDescription()

Output

string

Details

visibility: public
final: false
static: false

getTags
jump to class

getTags(
          
          )
        
        :
        array

getTags

Output

array: Array of Zend_CodeGenerator_Php_Docblock_Tag

Details

visibility: public
final: false
static: false

setLongDescription
jump to class

setLongDescription(
          string $longDescription
          )
        
        :
        Zend_CodeGenerator_Php_Docblock

setLongDescription()

Arguments

$longDescription: string

Output

Zend_CodeGenerator_Php_Docblock

Details

visibility: public
final: false
static: false

setShortDescription
jump to class

setShortDescription(
          string $shortDescription
          )
        
        :
        Zend_CodeGenerator_Php_Docblock

setShortDescription()

Arguments

$shortDescription: string

Output

Zend_CodeGenerator_Php_Docblock

Details

visibility: public
final: false
static: false

setTag
jump to class

setTag(
          array|Zend_CodeGenerator_Php_Docblock_Tag $tag
          )
        
        :
        Zend_CodeGenerator_Php_Docblock

setTag()

Arguments

$tag: arrayZend_CodeGenerator_Php_Docblock_Tag

Output

Zend_CodeGenerator_Php_Docblock

Details

visibility: public
final: false
static: false

setTags
jump to class

setTags(
          array $tags
          )
        
        :
        Zend_CodeGenerator_Php_Docblock

setTags()

Arguments

$tags: array

Output

Zend_CodeGenerator_Php_Docblock

Details

visibility: public
final: false
static: false

API Documentation

CodeGenerator/Php/Docblock.php

Description

Zend_CodeGenerator_Php_Docblockjump to top

Description

Properties

$_indentationjump to class

Details

$_longDescriptionjump to class

Details

$_shortDescriptionjump to class

Details

$_tagsjump to class

Details

Methods

_docCommentizejump to class

Arguments

Output

Details

fromReflectionjump to class

Arguments

Output

Details

generatejump to class

Output

Details

getLongDescriptionjump to class

Output

Details

getShortDescriptionjump to class

Output

Details

getTagsjump to class

Output

Details

setLongDescriptionjump to class

Arguments

Output

Details

setShortDescriptionjump to class

Arguments

Output

Details

setTagjump to class

Arguments

Output

Details

setTagsjump to class

Arguments

Output

Details

Zend_CodeGenerator_Php_Docblock
jump to top

$_indentation
jump to class

$_longDescription
jump to class

$_shortDescription
jump to class

$_tags
jump to class

_docCommentize
jump to class

fromReflection
jump to class

generate
jump to class

getLongDescription
jump to class

getShortDescription
jump to class

getTags
jump to class

setLongDescription
jump to class

setShortDescription
jump to class

setTag
jump to class

setTags
jump to class