apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
PHP_CodeSniffer


Classes:
PHP_CodeSniffer
   AbstractPatternSniff
   AbstractScopeSniff
   AbstractVariableSniff
   AjaxNullComparisonSniff
   ArrayBracketSpacingSniff
   ArrayDeclarationSniff
   AssignmentInConditionSniff
   AssignThisSniff
   Autoload
   BacktickOperatorSniff
   BlockCommentSniff
   BrowserSpecificStylesSniff
   ByteOrderMarkSniff
   Cache
   CallTimePassByReferenceSniff
   CamelCapsFunctionNameSniff
   CamelCapsMethodNameSniff
   CastSpacingSniff
   Cbf
   CharacterBeforePHPOpeningTagSniff
   Checkstyle
   ClassCommentSniff
   ClassDeclarationSniff
   ClassDefinitionClosingBraceSpaceSniff
   ClassDefinitionNameSpacingSniff
   ClassDefinitionOpeningBraceSpaceSniff
   ClassFileNameSniff
   ClosingDeclarationCommentSniff
   ClosingPHPTagSniff
   ClosingTagSniff
   ClosureLinterSniff
   CodeAnalyzerSniff
   ColonSpacingSniff
   ColourDefinitionSniff
   Comment
   CommentedOutCodeSniff
   Common
   ComparisonOperatorUsageSniff
   ConcatenationSpacingSniff
   Config
   ConstructorNameSniff
   ControlSignatureSniff
   ControlStructureSpacingSniff
   CreateWidgetTypeCallbackSniff
   CSS
   CSSLintSniff
   Csv
   CyclomaticComplexitySniff
   DebugCodeSniff
   DeepExitException
   DeprecatedFunctionsSniff
   Diff
   DisallowAlternativePHPTagsSniff
   DisallowBooleanStatementSniff
   DisallowComparisonAssignmentSniff
   DisallowInlineIfSniff
   DisallowLongArraySyntaxSniff
   DisallowMultipleAssignmentsSniff
   DisallowMultipleStatementsSniff
   DisallowMultipleStyleDefinitionsSniff
   DisallowNewWidgetSniff
   DisallowObEndFlushSniff
   DisallowObjectStringIndexSniff
   DisallowSelfActionsSniff
   DisallowShortArraySyntaxSniff
   DisallowShortOpenTagSniff
   DisallowSizeFunctionsInLoopsSniff
   DisallowSpaceIndentSniff
   DisallowTabIndentSniff
   DiscouragedFunctionsSniff
   DocCommentAlignmentSniff
   DocCommentSniff
   DoubleQuoteUsageSniff
   DummyFile
   DuplicateClassDefinitionSniff
   DuplicateClassNameSniff
   DuplicatePropertySniff
   DuplicateStyleDefinitionSniff
   EchoedStringsSniff
   ElseIfDeclarationSniff
   Emacs
   EmbeddedPhpSniff
   EmptyCatchCommentSniff
   EmptyClassDefinitionSniff
   EmptyStatementSniff
   EmptyStyleDefinitionSniff
   EndFileNewlineSniff
   EndFileNoNewlineSniff
   ESLintSniff
   EvalObjectFactorySniff
   EvalSniff
   ExactMatch
   File
   FileCommentSniff
   FileExtensionSniff
   FileList
   Filter
   FirebugConsoleSniff
   Fixer
   FixmeSniff
   ForbiddenFunctionsSniff
   ForbiddenStylesSniff
   ForEachLoopDeclarationSniff
   ForLoopDeclarationSniff
   ForLoopShouldBeWhileLoopSniff
   ForLoopWithTestFunctionCallSniff
   Full
   FunctionCallArgumentSpacingSniff
   FunctionCallSignatureSniff
   FunctionClosingBraceSniff
   FunctionClosingBraceSpaceSniff
   FunctionCommentSniff
   FunctionCommentThrowTagSniff
   FunctionDeclarationArgumentSpacingSniff
   FunctionDeclarationSniff
   FunctionDuplicateArgumentSniff
   FunctionOpeningBraceSpaceSniff
   FunctionSpacingSniff
   Generator
   GetRequestDataSniff
   Gitblame
   GitModified
   GlobalFunctionSniff
   GlobalKeywordSniff
   HeredocSniff
   Hgblame
   HTML
   IncludeOwnSystemSniff
   IncludeSystemSniff
   IncludingFileSniff
   IncrementDecrementUsageSniff
   IndentationSniff
   Info
   InlineCommentSniff
   InlineControlStructureSniff
   InlineHTMLSniff
   InlineIfDeclarationSniff
   InnerFunctionsSniff
   JavaScriptLintSniff
   JoinStringsSniff
   JS
   JSHintSniff
   JSLintSniff
   Json
   JumbledIncrementerSniff
   Junit
   LanguageConstructSpacingSniff
   LineEndingsSniff
   LineLengthSniff
   LocalFile
   LogicalOperatorSpacingSniff
   LongConditionClosingCommentSniff
   LowercaseClassKeywordsSniff
   LowerCaseConstantSniff
   LowercaseDeclarationSniff
   LowercasedFilenameSniff
   LowercaseFunctionKeywordsSniff
   LowerCaseKeywordSniff
   LowercasePHPFunctionsSniff
   LowercaseStyleDefinitionSniff
   Markdown
   MemberVarScopeSniff
   MemberVarSpacingSniff
   MethodDeclarationSniff
   MethodScopeSniff
   MissingColonSniff
   MultiLineAssignmentSniff
   MultiLineConditionSniff
   MultiLineFunctionDeclarationSniff
   MultipleStatementAlignmentSniff
   NamedColoursSniff
   NamespaceDeclarationSniff
   NestingLevelSniff
   NonExecutableCodeSniff
   NoSilencedErrorsSniff
   NoSpaceAfterCastSniff
   Notifysend
   ObjectInstantiationSniff
   ObjectMemberCommaSniff
   ObjectOperatorIndentSniff
   ObjectOperatorSpacingSniff
   OneClassPerFileSniff
   OneInterfacePerFileSniff
   OneObjectStructurePerFileSniff
   OneTraitPerFileSniff
   OpacitySniff
   OpeningBraceSameLineSniff
   OpeningFunctionBraceBsdAllmanSniff
   OpeningFunctionBraceKernighanRitchieSniff
   OperatorBracketSniff
   OperatorSpacingSniff
   PHP
   PostStatementCommentSniff
   PropertyDeclarationSniff
   PropertyLabelSpacingSniff
   Reporter
   ReturnFunctionValueSniff
   Ruleset
   Runner
   RuntimeException
   SAPIUsageSniff
   ScopeClosingBraceSniff
   ScopeIndentSniff
   ScopeKeywordSpacingSniff
   SelfMemberReferenceSniff
   SemicolonSpacingSniff
   ShorthandSizeSniff
   SideEffectsSniff
   Source
   SpaceAfterCastSniff
   SpaceAfterNotSniff
   Standards
   StaticThisUsageSniff
   SubversionPropertiesSniff
   Summary
   SuperfluousWhitespaceSniff
   Svnblame
   SwitchDeclarationSniff
   SyntaxSniff
   Text
   Timing
   TodoSniff
   Tokenizer
   TokenizerException
   Tokens
   UnconditionalIfStatementSniff
   UnnecessaryFinalModifierSniff
   UnnecessaryStringConcatSniff
   UnusedFunctionParameterSniff
   UnusedSystemSniff
   UpperCaseConstantNameSniff
   UpperCaseConstantSniff
   UseDeclarationSniff
   UselessOverridingMethodSniff
   ValidClassNameSniff
   ValidDefaultValueSniff
   ValidFunctionNameSniff
   ValidLogicalOperatorsSniff
   ValidVariableNameSniff
   VariableCommentSniff
   VersionControl
   Xml

Class: ClassCommentSniff

Source Location: /PHP_CodeSniffer-3.1.1/src/Standards/PEAR/Sniffs/Commenting/ClassCommentSniff.php

Class Overview

FileCommentSniff
   |
   --ClassCommentSniff

Parses and verifies the doc comments for classes.


Author(s):

Copyright:

  • 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)

Methods

Inherited Variables

Inherited Methods

Class Details

[line 15]
Parses and verifies the doc comments for classes.


[ Top ]

Method Detail

process   [line 44]

void process( File $phpcsFile, int $stackPtr)

Processes this test, when one of its tokens is encountered.
  • Access: public

Parameters:

\PHP_CodeSniffer\Files\File   $phpcsFile   —  The file being scanned.
int   $stackPtr   —  The position of the current token in the stack passed in $tokens.

[ Top ]

processVersion   [line 85]

void processVersion( \PHP_CodeSniffer\Files\File $phpcsFile, array $tags)

Process the version tag.
  • Access: protected

Parameters:

\PHP_CodeSniffer\Files\File   $phpcsFile   —  The file being scanned.
array   $tags   —  The tokens for these tags.

[ Top ]

register   [line 24]

array register( )

Returns an array of tokens this test wants to listen for.
  • Access: public

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:27:16 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.