Documentation

DocBlockDescriptions
in package

This would be detected as summary.

And this would be detected as the description.

Table of Contents

__invoke()  : mixed
Checks if the annotation has a summary and/or description property and uses the text in the comment block (above the annotations) as summary and/or description.
description()  : void
summaryAndDescription()  : void

Methods

__invoke()

Checks if the annotation has a summary and/or description property and uses the text in the comment block (above the annotations) as summary and/or description.

public __invoke(Analysis $analysis) : mixed

Use null @Annotation(description=null) if you don't want the annotation to have a description.

Parameters
$analysis : Analysis
Return values
mixed

description()

private description(mixed $annotation) : void
Parameters
$annotation : mixed
Return values
void

summaryAndDescription()

private summaryAndDescription(mixed $annotation) : void
Parameters
$annotation : mixed
Return values
void

Search results