PHP Class Zephir\Documentation\Docblock

A parsed Annotation

Show file Open project: phalcon/zephir Class Usage Examples

Protected Properties

Property	Type	Description
$annotations	Zephir\Documentation\Annotation[]
$description	string
$summary	string

Public Methods

Method	Description
__toString ( ) : string
addAnnotation ( Zephir\Documentation\Annotation $annotation )
generate ( ) : string
getAnnotations ( ) : Zephir\Documentation\Annotation[]
getAnnotationsByType ( string $type ) : Zephir\Documentation\Annotation[]
getDescription ( ) : string
getSummary ( ) : string
setAnnotations ( array $annotations )
setDescription ( string $description )
setSummary ( string $summary )

Method Details

__toString() public method

public __toString ( ) : string
return	string

addAnnotation() public method

public addAnnotation ( Zephir\Documentation\Annotation $annotation )
$annotation	Zephir\Documentation\Annotation

generate() public method

public generate ( ) : string
return	string

getAnnotations() public method

public getAnnotations ( ) : Zephir\Documentation\Annotation[]
return	Zephir\Documentation\Annotation[]

getAnnotationsByType() public method

public getAnnotationsByType ( string $type ) : Zephir\Documentation\Annotation[]
$type	string	the annotation name you want to get
return	Zephir\Documentation\Annotation[]	an array containing the annotations matching the name

getDescription() public method

public getDescription ( ) : string
return	string

getSummary() public method

public getSummary ( ) : string
return	string

setAnnotations() public method

public setAnnotations ( array $annotations )
$annotations	array

setDescription() public method

public setDescription ( string $description )
$description	string

setSummary() public method

public setSummary ( string $summary )
$summary	string

Property Details

$annotations protected property

protected Annotation[],Zephir\Documentation $annotations
return	Zephir\Documentation\Annotation[]

$description protected property

protected string $description
return	string

$summary protected property

protected string $summary
return	string