W3cubDocs

/Symfony 3.0

Symfony\Component\PropertyInfo\PropertyDescriptionExtractorInterface

interface PropertyDescriptionExtractorInterface

Description extractor Interface.

Methods

string|null getShortDescription(string $class, string $property, array $context = array())

Gets the short description of the property.

string|null getLongDescription(string $class, string $property, array $context = array())

Gets the long description of the property.

Details

public string|null getShortDescription(string $class, string $property, array $context = array())

Gets the short description of the property.

Parameters

string $class
string $property
array $context

Return Value

string|null

public string|null getLongDescription(string $class, string $property, array $context = array())

Gets the long description of the property.

Parameters

string $class
string $property
array $context

Return Value

string|null