PHP Класс Zephir\Documentation\Docblock

A parsed Annotation

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$annotations	Zephir\Documentation\Annotation[]
$description	string
$summary	string

Открытые методы

Метод	Описание
__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 )

Описание методов

__toString() публичный Метод

public __toString ( ) : string
Результат	string

addAnnotation() публичный Метод

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

generate() публичный Метод

public generate ( ) : string
Результат	string

getAnnotations() публичный Метод

public getAnnotations ( ) : Zephir\Documentation\Annotation[]
Результат	Zephir\Documentation\Annotation[]

getAnnotationsByType() публичный Метод

public getAnnotationsByType ( string $type ) : Zephir\Documentation\Annotation[]
$type	string	the annotation name you want to get
Результат	Zephir\Documentation\Annotation[]	an array containing the annotations matching the name

getDescription() публичный Метод

public getDescription ( ) : string
Результат	string

getSummary() публичный Метод

public getSummary ( ) : string
Результат	string

setAnnotations() публичный Метод

public setAnnotations ( array $annotations )
$annotations	array

setDescription() публичный Метод

public setDescription ( string $description )
$description	string

setSummary() публичный Метод

public setSummary ( string $summary )
$summary	string

Описание свойств

$annotations защищенное свойство

protected Annotation[],Zephir\Documentation $annotations
Результат	Zephir\Documentation\Annotation[]

$description защищенное свойство

protected string $description
Результат	string

$summary защищенное свойство

protected string $summary
Результат	string