PhpdocTrimConsecutiveBlankLineSeparationFixer
extends AbstractFixer
in package
Tags
Table of Contents
- getDefinition() : mixed
- {@inheritdoc}
- getPriority() : mixed
- {@inheritdoc}
- isCandidate() : mixed
- {@inheritdoc}
- applyFix() : mixed
- {@inheritdoc}
- findFirstAnnotationOrEnd() : int
- findNonBlankLine() : null|int
- fixAllTheRest() : mixed
- fixDescription() : mixed
- fixSummary() : mixed
- removeExtraBlankLine() : mixed
- removeExtraBlankLinesBetween() : mixed
- reverseFindLastUsefulContent() : null|int
Methods
getDefinition()
{@inheritdoc}
public
getDefinition() : mixed
Return values
mixed —getPriority()
{@inheritdoc}
public
getPriority() : mixed
Must run before PhpdocAlignFixer. Must run after AlignMultilineCommentFixer, AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
Return values
mixed —isCandidate()
{@inheritdoc}
public
isCandidate(Tokens $tokens) : mixed
Parameters
- $tokens : Tokens
Return values
mixed —applyFix()
{@inheritdoc}
protected
applyFix(SplFileInfo $file, Tokens $tokens) : mixed
Parameters
- $file : SplFileInfo
- $tokens : Tokens
Return values
mixed —findFirstAnnotationOrEnd()
private
findFirstAnnotationOrEnd(DocBlock $doc) : int
Parameters
- $doc : DocBlock
Return values
int —findNonBlankLine()
private
findNonBlankLine(DocBlock $doc, int $after) : null|int
Parameters
- $doc : DocBlock
- $after : int
Return values
null|int —fixAllTheRest()
private
fixAllTheRest(DocBlock $doc) : mixed
Parameters
- $doc : DocBlock
Return values
mixed —fixDescription()
private
fixDescription(DocBlock $doc, int $summaryEnd) : mixed
Parameters
- $doc : DocBlock
- $summaryEnd : int
Return values
mixed —fixSummary()
private
fixSummary(DocBlock $doc, int $summaryEnd) : mixed
Parameters
- $doc : DocBlock
- $summaryEnd : int
Return values
mixed —removeExtraBlankLine()
private
removeExtraBlankLine(Line $current, Line $next) : mixed
Parameters
Return values
mixed —removeExtraBlankLinesBetween()
private
removeExtraBlankLinesBetween(DocBlock $doc, int $from, int $to) : mixed
Parameters
- $doc : DocBlock
- $from : int
- $to : int
Return values
mixed —reverseFindLastUsefulContent()
private
reverseFindLastUsefulContent(DocBlock $doc, int $from) : null|int
Parameters
- $doc : DocBlock
- $from : int