Documentation

PhpdocSeparationFixer extends AbstractFixer
in package

Tags
author

Graham Campbell graham@alt-three.com

Table of Contents

getDefinition()  : mixed
{@inheritdoc}
getPriority()  : mixed
{@inheritdoc}
isCandidate()  : mixed
{@inheritdoc}
applyFix()  : mixed
{@inheritdoc}
ensureAreSeparate()  : mixed
Force the given annotations to have one empty line between each other.
ensureAreTogether()  : mixed
Force the given annotations to immediately follow each other.
fixAnnotations()  : string
Make sure the annotations are correctly separated.
fixDescription()  : mixed
Make sure the description is separated from the annotations.

Methods

getPriority()

{@inheritdoc}

public getPriority() : mixed

Must run before PhpdocAlignFixer. Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, GeneralPhpdocAnnotationRemoveFixer, PhpdocIndentFixer, PhpdocNoAccessFixer, PhpdocNoEmptyReturnFixer, PhpdocNoPackageFixer, PhpdocOrderFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.

Return values
mixed

applyFix()

{@inheritdoc}

protected applyFix(SplFileInfo $file, Tokens $tokens) : mixed
Parameters
$file : SplFileInfo
$tokens : Tokens
Return values
mixed

fixDescription()

Make sure the description is separated from the annotations.

private fixDescription(DocBlock $doc) : mixed
Parameters
$doc : DocBlock
Return values
mixed

Search results