Documentation

CommentToPhpdocFixer extends AbstractFixer
in package
implements ConfigurationDefinitionFixerInterface, WhitespacesAwareFixerInterface

Tags
author

Kuba Werłos werlos@gmail.com

Interfaces, Classes and Traits

ConfigurationDefinitionFixerInterface
WhitespacesAwareFixerInterface

Table of Contents

$ignoredTags  : array<string|int, string>
configure()  : mixed
{@inheritdoc}
getDefinition()  : mixed
{@inheritdoc}
getPriority()  : mixed
{@inheritdoc}
isCandidate()  : mixed
{@inheritdoc}
isRisky()  : mixed
{@inheritdoc}
applyFix()  : mixed
{@inheritdoc}
createConfigurationDefinition()  : mixed
{@inheritdoc}
fixComment()  : mixed
fixCommentMultiLine()  : mixed
fixCommentSingleLine()  : mixed
getMessage()  : mixed
isCommentCandidate()  : bool

Properties

Methods

configure()

{@inheritdoc}

public configure([array<string|int, mixed> $configuration = null ]) : mixed
Parameters
$configuration : array<string|int, mixed> = null
Return values
mixed

getPriority()

{@inheritdoc}

public getPriority() : mixed

Must run before GeneralPhpdocAnnotationRemoveFixer, GeneralPhpdocTagRenameFixer, NoBlankLinesAfterPhpdocFixer, NoEmptyPhpdocFixer, NoSuperfluousPhpdocTagsFixer, PhpdocAddMissingParamAnnotationFixer, PhpdocAlignFixer, PhpdocAlignFixer, PhpdocAnnotationWithoutDotFixer, PhpdocInlineTagFixer, PhpdocInlineTagNormalizerFixer, PhpdocLineSpanFixer, PhpdocNoAccessFixer, PhpdocNoAliasTagFixer, PhpdocNoEmptyReturnFixer, PhpdocNoPackageFixer, PhpdocNoUselessInheritdocFixer, PhpdocOrderByValueFixer, PhpdocOrderFixer, PhpdocReturnSelfReferenceFixer, PhpdocSeparationFixer, PhpdocSingleLineVarSpacingFixer, PhpdocSummaryFixer, PhpdocTagCasingFixer, PhpdocTagTypeFixer, PhpdocToCommentFixer, PhpdocToParamTypeFixer, PhpdocToPropertyTypeFixer, PhpdocToReturnTypeFixer, PhpdocTrimConsecutiveBlankLineSeparationFixer, PhpdocTrimFixer, PhpdocTypesOrderFixer, PhpdocVarAnnotationCorrectOrderFixer, PhpdocVarWithoutNameFixer. Must run after AlignMultilineCommentFixer.

Return values
mixed

applyFix()

{@inheritdoc}

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

createConfigurationDefinition()

{@inheritdoc}

protected createConfigurationDefinition() : mixed
Return values
mixed

fixComment()

private fixComment(Tokens $tokens, array<string|int, int> $indices) : mixed
Parameters
$tokens : Tokens
$indices : array<string|int, int>
Return values
mixed

fixCommentMultiLine()

private fixCommentMultiLine(Tokens $tokens, array<string|int, int> $indices) : mixed
Parameters
$tokens : Tokens
$indices : array<string|int, int>
Return values
mixed

fixCommentSingleLine()

private fixCommentSingleLine(Tokens $tokens, int $index) : mixed
Parameters
$tokens : Tokens
$index : int
Return values
mixed

getMessage()

private getMessage(mixed $content) : mixed
Parameters
$content : mixed
Return values
mixed

isCommentCandidate()

private isCommentCandidate(Tokens $tokens, array<string|int, int> $indices) : bool
Parameters
$tokens : Tokens
$indices : array<string|int, int>
Return values
bool

Search results