DocCommentUnitTest
extends AbstractSniffUnitTest
in package
FinalYes
Unit test class for the DocCommentSniff sniff.
Tags
Table of Contents
Methods
- getErrorList() : mixed
- Returns the lines where errors should occur.
- getWarningList() : mixed
- Returns the lines where warnings should occur.
- setCliValues() : void
- Get a list of CLI values to set before the file is tested.
Methods
getErrorList()
Returns the lines where errors should occur.
public
getErrorList([string $testFile = '' ]) : mixed
The key of the array should represent the line number and the value should represent the number of errors that should occur on that line.
Parameters
- $testFile : string = ''
-
The name of the file being tested.
Tags
getWarningList()
Returns the lines where warnings should occur.
public
getWarningList() : mixed
The key of the array should represent the line number and the value should represent the number of warnings that should occur on that line.
Tags
setCliValues()
Get a list of CLI values to set before the file is tested.
public
setCliValues(string $testFile, Config $config) : void
Parameters
- $testFile : string
-
The name of the file being tested.
- $config : Config
-
The config data for the test run.