mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
35e8abedeb
People generally have expressed a dislike for the Hungarian notation used in member variables, especially in examples/templates, and our styleguide shouldn't be forced on downstream consumers, so this removes all Hungarian notation from the examples/templates. There are _some_ benefits to Hungarian for private member variables (like knowing what's a member vs. local in a PR review) so we'll keep private member variables the same for now, but public variables should no longer use Hungarian notation, since it looks much worse. A new PMD XPath rule has been added to accomplish this goal. Some other non-compliant variables were fixed for the new rule.
25 lines
1.4 KiB
XML
25 lines
1.4 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE
|
|
suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN"
|
|
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
|
|
<suppressions>
|
|
<suppress files=".*test.*" checks="MissingJavadocMethod" />
|
|
<suppress files=".*wpilibjIntegrationTests.*"
|
|
checks="MissingJavadocMethod" />
|
|
<suppress files="wpimath.*"
|
|
checks="(LocalVariableName|MethodName|MethodTypeParameterName|ParameterName)" />
|
|
<suppress files=".*JNI.*"
|
|
checks="(EmptyLineSeparator|LineLength|MissingJavadocMethod|ParameterName)" />
|
|
<!-- Disable checks for generated protobuf files -->
|
|
<suppress files=".*generated[/\\].*[/\\]proto[/\\].*"
|
|
checks="(CustomImportOrder|EmptyLineSeparator|LeftCurly|LineLength|JavadocParagraph|MissingJavadocMethod|OverloadMethodsDeclarationOrder|SummaryJavadoc|UnnecessaryParentheses|OperatorWrap|JavadocMethod|JavadocTagContinuationIndentation)" />
|
|
<suppress files="wpilibj[/\\]src[/\\]generated.*"
|
|
checks="MethodName" />
|
|
<!-- Disable checkstyle for generated unit files -->
|
|
<suppress files="wpiunits[/\\]src[/\\]generated.*" checks=".*"/>
|
|
<suppress files="wpilibj[/\\]src[/\\]main[/\\]java[/\\]edu[/\\]wpi[/\\]first[/\\]wpilibj[/\\]I2C.java"
|
|
checks="OverloadMethodsDeclarationOrder" />
|
|
<!-- Disable LineLength for generated version file -->
|
|
<suppress files="wpilibj[/\\]build[/\\]generated.*" checks="LineLength"/>
|
|
</suppressions>
|