[phpcs] Add documentation

This commit is contained in:
logmanoriginal 2017-02-14 16:50:34 +01:00
parent 0c3e58258c
commit 23430f1c07

View file

@ -3,27 +3,46 @@
<description>Created with the PHP Coding Standard Generator. http://edorian.github.com/php-coding-standard-generator/</description> <description>Created with the PHP Coding Standard Generator. http://edorian.github.com/php-coding-standard-generator/</description>
<exclude-pattern>./css</exclude-pattern> <exclude-pattern>./css</exclude-pattern>
<exclude-pattern>./vendor</exclude-pattern> <exclude-pattern>./vendor</exclude-pattern>
<!-- Duplicate class names are not allowed -->
<rule ref="Generic.Classes.DuplicateClassName"/> <rule ref="Generic.Classes.DuplicateClassName"/>
<!-- Statements must not be empty -->
<rule ref="Generic.CodeAnalysis.EmptyStatement"/> <rule ref="Generic.CodeAnalysis.EmptyStatement"/>
<!-- Unconditional if-statements are not allowed -->
<rule ref="Generic.CodeAnalysis.UnconditionalIfStatement"/> <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement"/>
<!-- Do not use final statements inside final classes -->
<rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/> <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/>
<!-- Do not override methods to call their parent -->
<rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/> <rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/>
<!-- One line should not have more than 80 characters -->
<!-- One line must never exceed 120 characters -->
<rule ref="Generic.Files.LineLength"> <rule ref="Generic.Files.LineLength">
<properties> <properties>
<property name="lineLimit" value="80"/> <property name="lineLimit" value="80"/>
<property name="absoluteLineLimit" value="120"/> <property name="absoluteLineLimit" value="120"/>
</properties> </properties>
</rule> </rule>
<!-- Use UPPERCARE for constants -->
<rule ref="Generic.NamingConventions.UpperCaseConstantName"/> <rule ref="Generic.NamingConventions.UpperCaseConstantName"/>
<!-- Use lowercase for 'true', 'false' and 'null' -->
<rule ref="Generic.PHP.LowerCaseConstant"/> <rule ref="Generic.PHP.LowerCaseConstant"/>
<!-- Use a single string instead of concating -->
<rule ref="Generic.Strings.UnnecessaryStringConcat"/> <rule ref="Generic.Strings.UnnecessaryStringConcat"/>
<!-- Use tabs for indentation -->
<rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/> <rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/>
<!-- Parameters with default values must appear last in functions -->
<rule ref="PEAR.Functions.ValidDefaultValue"/> <rule ref="PEAR.Functions.ValidDefaultValue"/>
<!-- Use PascalCase for class names -->
<rule ref="PEAR.NamingConventions.ValidClassName"/> <rule ref="PEAR.NamingConventions.ValidClassName"/>
<!-- Use 'elseif' instead of 'else if' -->
<rule ref="PSR2.ControlStructures.ElseIfDeclaration"/> <rule ref="PSR2.ControlStructures.ElseIfDeclaration"/>
<!-- Add a new line at the end of a file -->
<rule ref="PSR2.Files.EndFileNewline"/> <rule ref="PSR2.Files.EndFileNewline"/>
<!-- Do not add spaces when casting -->
<rule ref="Squiz.WhiteSpace.CastSpacing"/> <rule ref="Squiz.WhiteSpace.CastSpacing"/>
<!-- Operators must have a space around them -->
<rule ref="Squiz.WhiteSpace.OperatorSpacing"/> <rule ref="Squiz.WhiteSpace.OperatorSpacing"/>
<!-- Do not add a whitespace before a semicolon -->
<rule ref="Squiz.WhiteSpace.SemicolonSpacing"/> <rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
<!-- Do not add whitespace at start or end of a file or end of a line -->
<rule ref="Squiz.WhiteSpace.SuperfluousWhitespace"/> <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace"/>
</ruleset> </ruleset>