Zend Framework  1.12
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_CodeGenerator_Php_Docblock Class Reference

Public Member Functions

 setShortDescription ($shortDescription)
 setShortDescription()
 
 getShortDescription ()
 getShortDescription()
 
 setLongDescription ($longDescription)
 setLongDescription()
 
 getLongDescription ()
 getLongDescription()
 
 setTags (Array $tags)
 setTags()
 
 setTag ($tag)
 setTag()
 
 getTags ()
 getTags
 
 generate ()
 generate()
 
- Public Member Functions inherited from Zend_CodeGenerator_Php_Abstract
 setSourceDirty ($isSourceDirty=true)
 setSourceDirty()
 
 isSourceDirty ()
 isSourceDirty()
 
 setIndentation ($indentation)
 setIndentation()
 
 getIndentation ()
 getIndentation()
 
- Public Member Functions inherited from Zend_CodeGenerator_Abstract
 __construct ($options=array())
 __construct()
 
 setConfig (Zend_Config $config)
 setConfig()
 
 setOptions (Array $options)
 setOptions()
 
 setSourceContent ($sourceContent)
 setSourceContent()
 
 getSourceContent ()
 getSourceContent()
 
 generate ()
 generate() - must be implemented by the child
 
 __toString ()
 __toString() - casting to a string will in turn call generate()
 

Static Public Member Functions

static fromReflection (Zend_Reflection_Docblock $reflectionDocblock)
 fromReflection() - Build a docblock generator object from a reflection object
 

Protected Member Functions

 _docCommentize ($content)
 _docCommentize()
 

Protected Attributes

 $_shortDescription = null
 
 $_longDescription = null
 
 $_tags = array()
 
 $_indentation = ''
 
- Protected Attributes inherited from Zend_CodeGenerator_Php_Abstract
 $_isSourceDirty = true
 
 $_indentation = ' '
 
- Protected Attributes inherited from Zend_CodeGenerator_Abstract
 $_sourceContent = null
 
 $_isSourceDirty = true
 

Additional Inherited Members

- Public Attributes inherited from Zend_CodeGenerator_Php_Abstract
const LINE_FEED = "\n"
 Line feed to use in place of EOL.
 

Member Function Documentation

_docCommentize (   $content)
protected

_docCommentize()

Parameters
string$content
Returns
string
static fromReflection ( Zend_Reflection_Docblock  $reflectionDocblock)
static

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

Parameters
Zend_Reflection_Docblock$reflectionDocblock
Returns
Zend_CodeGenerator_Php_Docblock
generate ( )

generate()

Returns
string
getLongDescription ( )

getLongDescription()

Returns
string
getShortDescription ( )

getShortDescription()

Returns
string
getTags ( )

getTags

Returns
array Array of Zend_CodeGenerator_Php_Docblock_Tag
setLongDescription (   $longDescription)

setLongDescription()

Parameters
string$longDescription
Returns
Zend_CodeGenerator_Php_Docblock
setShortDescription (   $shortDescription)

setShortDescription()

Parameters
string$shortDescription
Returns
Zend_CodeGenerator_Php_Docblock
setTag (   $tag)
setTags ( Array  $tags)

setTags()

Parameters
array$tags
Returns
Zend_CodeGenerator_Php_Docblock

Member Data Documentation

$_indentation = ''
protected
$_longDescription = null
protected
$_shortDescription = null
protected
$_tags = array()
protected