Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-19 00:41:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Format HTML and XML files (#944)

Browse Source 
Generated by wpilibsuite/styleguide#52.
This commit is contained in:
Tyler Veness
2018-05-15 23:58:20 -07:00
committed by Peter Johnson
parent adb6098353
commit d8c8643b52
7 changed files with 633 additions and 503 deletions
Download Patch File Download Diff File Expand all files Collapse all files

206
styleguide/checkstyle.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<!DOCTYPE module PUBLIC <!DOCTYPE
"-//Puppy Crawl//DTD Check Configuration 1.3//EN" module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<!-- <!--
Checkstyle configuration that checks the Google coding conventions from Google Java Style Checkstyle configuration that checks the Google coding conventions from Google Java Style
that can be found at https://google.github.io/styleguide/javaguide.html. that can be found at https://google.github.io/styleguide/javaguide.html.
@@ -14,44 +13,52 @@
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov. Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
--> -->
<module name="Checker"> <module name="Checker">
<property name="charset" value="UTF-8"/> <property name="charset"
value="UTF-8" />
<property name="severity" value="error"/> <property name="severity"
value="error" />
<module name="SuppressionFilter"> <module name="SuppressionFilter">
<property name="file" value="styleguide/suppressions.xml" /> <property name="file"
value="styleguide/suppressions.xml" />
</module> </module>
<property name="fileExtensions"
<property name="fileExtensions" value="java, properties, xml"/> value="java, properties, xml" />
<!-- Checks for whitespace --> <!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html --> <!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="FileTabCharacter"> <module name="FileTabCharacter">
<property name="eachLine" value="true"/> <property name="eachLine"
value="true" />
</module> </module>
<module name="NewlineAtEndOfFile"> <module name="NewlineAtEndOfFile">
<property name="lineSeparator" value="lf"/> <property name="lineSeparator"
value="lf" />
</module> </module>
<module name="SuppressWarningsFilter" /> <module name="SuppressWarningsFilter" />
<module name="TreeWalker"> <module name="TreeWalker">
<module name="SuppressWarningsHolder" /> <module name="SuppressWarningsHolder" />
<module name="OuterTypeFilename" /> <module name="OuterTypeFilename" />
<module name="IllegalTokenText"> <module name="IllegalTokenText">
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/> <property name="tokens"
<property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/> value="STRING_LITERAL, CHAR_LITERAL" />
<property name="message" value="Avoid using corresponding octal or Unicode escape."/> <property name="format"
value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)" />
<property name="message"
value="Avoid using corresponding octal or Unicode escape." />
</module> </module>
<module name="AvoidEscapedUnicodeCharacters"> <module name="AvoidEscapedUnicodeCharacters">
<property name="allowEscapesForControlCharacters" value="true"/> <property name="allowEscapesForControlCharacters"
<property name="allowByTailComment" value="true"/> value="true" />
<property name="allowNonPrintableEscapes" value="true"/> <property name="allowByTailComment"
value="true" />
<property name="allowNonPrintableEscapes"
value="true" />
</module> </module>
<module name="LineLength"> <module name="LineLength">
<property name="max" value="100"/> <property name="max"
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/> value="100" />
<property name="ignorePattern"
value="^package.*|^import.*|a href|href|http://|https://|ftp://" />
</module> </module>
<module name="AvoidStarImport" /> <module name="AvoidStarImport" />
<module name="RedundantImport" /> <module name="RedundantImport" />
@@ -59,23 +66,32 @@
<module name="OneTopLevelClass" /> <module name="OneTopLevelClass" />
<module name="NoLineWrap" /> <module name="NoLineWrap" />
<module name="EmptyBlock"> <module name="EmptyBlock">
<property name="option" value="TEXT"/> <property name="option"
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/> value="TEXT" />
<property name="tokens"
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH" />
</module> </module>
<module name="NeedBraces" /> <module name="NeedBraces" />
<module name="LeftCurly"> <module name="LeftCurly">
<property name="maxLineLength" value="100"/> <property name="maxLineLength"
value="100" />
</module> </module>
<module name="RightCurly" /> <module name="RightCurly" />
<module name="RightCurly"> <module name="RightCurly">
<property name="option" value="alone"/> <property name="option"
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/> value="alone" />
<property name="tokens"
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT" />
</module> </module>
<module name="WhitespaceAround"> <module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/> <property name="allowEmptyConstructors"
<property name="allowEmptyMethods" value="true"/> value="true" />
<property name="allowEmptyTypes" value="true"/> <property name="allowEmptyMethods"
<property name="allowEmptyLoops" value="true"/> value="true" />
<property name="allowEmptyTypes"
value="true" />
<property name="allowEmptyLoops"
value="true" />
<message key="ws.notFollowed" <message key="ws.notFollowed"
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)" /> value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)" />
<message key="ws.notPreceded" <message key="ws.notPreceded"
@@ -95,18 +111,24 @@
<module name="ModifierOrder" /> <module name="ModifierOrder" />
<module name="RedundantModifier" /> <module name="RedundantModifier" />
<module name="EmptyLineSeparator"> <module name="EmptyLineSeparator">
<property name="allowNoEmptyLineBetweenFields" value="true"/> <property name="allowNoEmptyLineBetweenFields"
value="true" />
</module> </module>
<module name="SeparatorWrap"> <module name="SeparatorWrap">
<property name="tokens" value="DOT"/> <property name="tokens"
<property name="option" value="nl"/> value="DOT" />
<property name="option"
value="nl" />
</module> </module>
<module name="SeparatorWrap"> <module name="SeparatorWrap">
<property name="tokens" value="COMMA"/> <property name="tokens"
<property name="option" value="EOL"/> value="COMMA" />
<property name="option"
value="EOL" />
</module> </module>
<module name="PackageName"> <module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/> <property name="format"
value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Package name ''{0}'' must match pattern ''{1}''." /> value="Package name ''{0}'' must match pattern ''{1}''." />
</module> </module>
@@ -115,39 +137,48 @@
value="Type name ''{0}'' must match pattern ''{1}''." /> value="Type name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="MemberName"> <module name="MemberName">
<property name="format" value="^m_[a-z][a-z0-9][a-zA-Z0-9]*$"/> <property name="format"
value="^m_[a-z][a-z0-9][a-zA-Z0-9]*$" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Member name ''{0}'' must match pattern ''{1}''." /> value="Member name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="ParameterName"> <module name="ParameterName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> <property name="format"
value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Parameter name ''{0}'' must match pattern ''{1}''." /> value="Parameter name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="CatchParameterName"> <module name="CatchParameterName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> <property name="format"
value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Catch parameter name ''{0}'' must match pattern ''{1}''." /> value="Catch parameter name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="LocalVariableName"> <module name="LocalVariableName">
<property name="tokens" value="VARIABLE_DEF"/> <property name="tokens"
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> value="VARIABLE_DEF" />
<property name="allowOneCharVarInForLoop" value="true"/> <property name="format"
value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
<property name="allowOneCharVarInForLoop"
value="true" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Local variable name ''{0}'' must match pattern ''{1}''." /> value="Local variable name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="ClassTypeParameterName"> <module name="ClassTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> <property name="format"
value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Class type name ''{0}'' must match pattern ''{1}''." /> value="Class type name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="MethodTypeParameterName"> <module name="MethodTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> <property name="format"
value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Method type name ''{0}'' must match pattern ''{1}''." /> value="Method type name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="InterfaceTypeParameterName"> <module name="InterfaceTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> <property name="format"
value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Interface type name ''{0}'' must match pattern ''{1}''." /> value="Interface type name ''{0}'' must match pattern ''{1}''." />
</module> </module>
@@ -163,64 +194,91 @@
value="GenericWhitespace ''{0}'' is not preceded with whitespace." /> value="GenericWhitespace ''{0}'' is not preceded with whitespace." />
</module> </module>
<module name="Indentation"> <module name="Indentation">
<property name="basicOffset" value="2"/> <property name="basicOffset"
<property name="braceAdjustment" value="0"/> value="2" />
<property name="caseIndent" value="2"/> <property name="braceAdjustment"
<property name="throwsIndent" value="4"/> value="0" />
<property name="lineWrappingIndentation" value="4"/> <property name="caseIndent"
<property name="arrayInitIndent" value="2"/> value="2" />
<property name="throwsIndent"
value="4" />
<property name="lineWrappingIndentation"
value="4" />
<property name="arrayInitIndent"
value="2" />
</module> </module>
<module name="AbbreviationAsWordInName"> <module name="AbbreviationAsWordInName">
<property name="ignoreFinal" value="false"/> <property name="ignoreFinal"
<property name="allowedAbbreviationLength" value="3"/> value="false" />
<property name="allowedAbbreviationLength"
value="3" />
</module> </module>
<module name="OverloadMethodsDeclarationOrder" /> <module name="OverloadMethodsDeclarationOrder" />
<module name="VariableDeclarationUsageDistance" /> <module name="VariableDeclarationUsageDistance" />
<module name="MethodParamPad" /> <module name="MethodParamPad" />
<module name="TypecastParenPad" /> <module name="TypecastParenPad" />
<module name="OperatorWrap"> <module name="OperatorWrap">
<property name="option" value="NL"/> <property name="option"
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/> value="NL" />
<property name="tokens"
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR " />
</module> </module>
<module name="AnnotationLocation"> <module name="AnnotationLocation">
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/> <property name="tokens"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF" />
</module> </module>
<module name="AnnotationLocation"> <module name="AnnotationLocation">
<property name="tokens" value="VARIABLE_DEF"/> <property name="tokens"
<property name="allowSamelineMultipleAnnotations" value="true"/> value="VARIABLE_DEF" />
<property name="allowSamelineMultipleAnnotations"
value="true" />
</module> </module>
<module name="NonEmptyAtclauseDescription" /> <module name="NonEmptyAtclauseDescription" />
<module name="JavadocTagContinuationIndentation" /> <module name="JavadocTagContinuationIndentation" />
<module name="SummaryJavadoc"> <module name="SummaryJavadoc">
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/> <property name="forbiddenSummaryFragments"
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )" />
</module> </module>
<module name="JavadocParagraph" /> <module name="JavadocParagraph" />
<module name="AtclauseOrder"> <module name="AtclauseOrder">
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/> <property name="tagOrder"
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/> value="@param, @return, @throws, @deprecated" />
<property name="target"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
</module> </module>
<module name="JavadocMethod"> <module name="JavadocMethod">
<property name="scope" value="public"/> <property name="scope"
<property name="allowMissingParamTags" value="true"/> value="public" />
<property name="allowMissingThrowsTags" value="true"/> <property name="allowMissingParamTags"
<property name="allowMissingReturnTag" value="true"/> value="true" />
<property name="minLineCount" value="2"/> <property name="allowMissingThrowsTags"
value="true" />
<property name="allowMissingReturnTag"
value="true" />
<property name="minLineCount"
value="2" />
<property name="allowedAnnotations" <property name="allowedAnnotations"
value="Override, Test, Before, After, BeforeClass, AfterClass, Parameters" /> value="Override, Test, Before, After, BeforeClass, AfterClass, Parameters" />
<property name="allowUndeclaredRTE" value="true"/> <property name="allowUndeclaredRTE"
<property name="allowThrowsTagsForSubclasses" value="true"/> value="true" />
<property name="suppressLoadErrors" value="true"/> <property name="allowThrowsTagsForSubclasses"
value="true" />
<property name="suppressLoadErrors"
value="true" />
</module> </module>
<module name="MethodName"> <module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/> <property name="format"
value="^[a-z][a-z0-9][a-zA-Z0-9_]*$" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Method name ''{0}'' must match pattern ''{1}''." /> value="Method name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="SingleLineJavadoc"> <module name="SingleLineJavadoc">
<property name="ignoreInlineTags" value="false"/> <property name="ignoreInlineTags"
value="false" />
</module> </module>
<module name="EmptyCatchBlock"> <module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="expected"/> <property name="exceptionVariableName"
value="expected" />
</module> </module>
<module name="CommentsIndentation" /> <module name="CommentsIndentation" />
</module> </module>

212
styleguide/checkstyleExamples.xml
View File

@@ -1,8 +1,7 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<!DOCTYPE module PUBLIC <!DOCTYPE
"-//Puppy Crawl//DTD Check Configuration 1.3//EN" module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<!-- <!--
Checkstyle configuration that checks the Google coding conventions from Google Java Style Checkstyle configuration that checks the Google coding conventions from Google Java Style
that can be found at https://google.github.io/styleguide/javaguide.html. that can be found at https://google.github.io/styleguide/javaguide.html.
@@ -14,44 +13,52 @@
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov. Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
--> -->
<module name="Checker"> <module name="Checker">
<property name="charset" value="UTF-8"/> <property name="charset"
value="UTF-8" />
<property name="severity" value="error"/> <property name="severity"
value="error" />
<module name="SuppressionFilter"> <module name="SuppressionFilter">
<property name="file" value="styleguide/suppressions.xml" /> <property name="file"
value="styleguide/suppressions.xml" />
</module> </module>
<property name="fileExtensions"
<property name="fileExtensions" value="java, properties, xml"/> value="java, properties, xml" />
<!-- Checks for whitespace --> <!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html --> <!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="FileTabCharacter"> <module name="FileTabCharacter">
<property name="eachLine" value="true"/> <property name="eachLine"
value="true" />
</module> </module>
<module name="NewlineAtEndOfFile"> <module name="NewlineAtEndOfFile">
<property name="lineSeparator" value="lf"/> <property name="lineSeparator"
value="lf" />
</module> </module>
<module name="SuppressWarningsFilter" /> <module name="SuppressWarningsFilter" />
<module name="TreeWalker"> <module name="TreeWalker">
<module name="SuppressWarningsHolder" /> <module name="SuppressWarningsHolder" />
<module name="OuterTypeFilename" /> <module name="OuterTypeFilename" />
<module name="IllegalTokenText"> <module name="IllegalTokenText">
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/> <property name="tokens"
<property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/> value="STRING_LITERAL, CHAR_LITERAL" />
<property name="message" value="Avoid using corresponding octal or Unicode escape."/> <property name="format"
value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)" />
<property name="message"
value="Avoid using corresponding octal or Unicode escape." />
</module> </module>
<module name="AvoidEscapedUnicodeCharacters"> <module name="AvoidEscapedUnicodeCharacters">
<property name="allowEscapesForControlCharacters" value="true"/> <property name="allowEscapesForControlCharacters"
<property name="allowByTailComment" value="true"/> value="true" />
<property name="allowNonPrintableEscapes" value="true"/> <property name="allowByTailComment"
value="true" />
<property name="allowNonPrintableEscapes"
value="true" />
</module> </module>
<module name="LineLength"> <module name="LineLength">
<property name="max" value="100"/> <property name="max"
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/> value="100" />
<property name="ignorePattern"
value="^package.*|^import.*|a href|href|http://|https://|ftp://" />
</module> </module>
<module name="AvoidStarImport" /> <module name="AvoidStarImport" />
<module name="RedundantImport" /> <module name="RedundantImport" />
@@ -59,23 +66,32 @@
<module name="OneTopLevelClass" /> <module name="OneTopLevelClass" />
<module name="NoLineWrap" /> <module name="NoLineWrap" />
<module name="EmptyBlock"> <module name="EmptyBlock">
<property name="option" value="TEXT"/> <property name="option"
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/> value="TEXT" />
<property name="tokens"
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH" />
</module> </module>
<module name="NeedBraces" /> <module name="NeedBraces" />
<module name="LeftCurly"> <module name="LeftCurly">
<property name="maxLineLength" value="100"/> <property name="maxLineLength"
value="100" />
</module> </module>
<module name="RightCurly" /> <module name="RightCurly" />
<module name="RightCurly"> <module name="RightCurly">
<property name="option" value="alone"/> <property name="option"
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/> value="alone" />
<property name="tokens"
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT" />
</module> </module>
<module name="WhitespaceAround"> <module name="WhitespaceAround">
<property name="allowEmptyConstructors" value="true"/> <property name="allowEmptyConstructors"
<property name="allowEmptyMethods" value="true"/> value="true" />
<property name="allowEmptyTypes" value="true"/> <property name="allowEmptyMethods"
<property name="allowEmptyLoops" value="true"/> value="true" />
<property name="allowEmptyTypes"
value="true" />
<property name="allowEmptyLoops"
value="true" />
<message key="ws.notFollowed" <message key="ws.notFollowed"
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)" /> value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)" />
<message key="ws.notPreceded" <message key="ws.notPreceded"
@@ -95,18 +111,24 @@
<module name="ModifierOrder" /> <module name="ModifierOrder" />
<module name="RedundantModifier" /> <module name="RedundantModifier" />
<module name="EmptyLineSeparator"> <module name="EmptyLineSeparator">
<property name="allowNoEmptyLineBetweenFields" value="true"/> <property name="allowNoEmptyLineBetweenFields"
value="true" />
</module> </module>
<module name="SeparatorWrap"> <module name="SeparatorWrap">
<property name="tokens" value="DOT"/> <property name="tokens"
<property name="option" value="nl"/> value="DOT" />
<property name="option"
value="nl" />
</module> </module>
<module name="SeparatorWrap"> <module name="SeparatorWrap">
<property name="tokens" value="COMMA"/> <property name="tokens"
<property name="option" value="EOL"/> value="COMMA" />
<property name="option"
value="EOL" />
</module> </module>
<module name="PackageName"> <module name="PackageName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/> <property name="format"
value="^[a-z]+(\.[a-z][a-z0-9]*)*$" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Package name ''{0}'' must match pattern ''{1}''." /> value="Package name ''{0}'' must match pattern ''{1}''." />
</module> </module>
@@ -115,39 +137,48 @@
value="Type name ''{0}'' must match pattern ''{1}''." /> value="Type name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="MemberName"> <module name="MemberName">
<property name="format" value="^m_[a-z][a-z0-9][a-zA-Z0-9]*$"/> <property name="format"
value="^m_[a-z][a-z0-9][a-zA-Z0-9]*$" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Member name ''{0}'' must match pattern ''{1}''." /> value="Member name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="ParameterName"> <module name="ParameterName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> <property name="format"
value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Parameter name ''{0}'' must match pattern ''{1}''." /> value="Parameter name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="CatchParameterName"> <module name="CatchParameterName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> <property name="format"
value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Catch parameter name ''{0}'' must match pattern ''{1}''." /> value="Catch parameter name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="LocalVariableName"> <module name="LocalVariableName">
<property name="tokens" value="VARIABLE_DEF"/> <property name="tokens"
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> value="VARIABLE_DEF" />
<property name="allowOneCharVarInForLoop" value="true"/> <property name="format"
value="^[a-z][a-z0-9][a-zA-Z0-9]*$" />
<property name="allowOneCharVarInForLoop"
value="true" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Local variable name ''{0}'' must match pattern ''{1}''." /> value="Local variable name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="ClassTypeParameterName"> <module name="ClassTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> <property name="format"
value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Class type name ''{0}'' must match pattern ''{1}''." /> value="Class type name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="MethodTypeParameterName"> <module name="MethodTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> <property name="format"
value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Method type name ''{0}'' must match pattern ''{1}''." /> value="Method type name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="InterfaceTypeParameterName"> <module name="InterfaceTypeParameterName">
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> <property name="format"
value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Interface type name ''{0}'' must match pattern ''{1}''." /> value="Interface type name ''{0}'' must match pattern ''{1}''." />
</module> </module>
@@ -163,67 +194,96 @@
value="GenericWhitespace ''{0}'' is not preceded with whitespace." /> value="GenericWhitespace ''{0}'' is not preceded with whitespace." />
</module> </module>
<module name="Indentation"> <module name="Indentation">
<property name="basicOffset" value="2"/> <property name="basicOffset"
<property name="braceAdjustment" value="0"/> value="2" />
<property name="caseIndent" value="2"/> <property name="braceAdjustment"
<property name="throwsIndent" value="4"/> value="0" />
<property name="lineWrappingIndentation" value="4"/> <property name="caseIndent"
<property name="arrayInitIndent" value="2"/> value="2" />
<property name="throwsIndent"
value="4" />
<property name="lineWrappingIndentation"
value="4" />
<property name="arrayInitIndent"
value="2" />
</module> </module>
<module name="AbbreviationAsWordInName"> <module name="AbbreviationAsWordInName">
<property name="ignoreFinal" value="false"/> <property name="ignoreFinal"
<property name="allowedAbbreviationLength" value="3"/> value="false" />
<property name="allowedAbbreviationLength"
value="3" />
</module> </module>
<module name="OverloadMethodsDeclarationOrder" /> <module name="OverloadMethodsDeclarationOrder" />
<module name="VariableDeclarationUsageDistance"> <module name="VariableDeclarationUsageDistance">
<property name="allowedDistance" value="8"/> <property name="allowedDistance"
value="8" />
</module> </module>
<module name="MethodParamPad" /> <module name="MethodParamPad" />
<module name="TypecastParenPad" /> <module name="TypecastParenPad" />
<module name="OperatorWrap"> <module name="OperatorWrap">
<property name="option" value="NL"/> <property name="option"
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/> value="NL" />
<property name="tokens"
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR " />
</module> </module>
<module name="AnnotationLocation"> <module name="AnnotationLocation">
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/> <property name="tokens"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF" />
</module> </module>
<module name="AnnotationLocation"> <module name="AnnotationLocation">
<property name="tokens" value="VARIABLE_DEF"/> <property name="tokens"
<property name="allowSamelineMultipleAnnotations" value="true"/> value="VARIABLE_DEF" />
<property name="allowSamelineMultipleAnnotations"
value="true" />
</module> </module>
<module name="NonEmptyAtclauseDescription" /> <module name="NonEmptyAtclauseDescription" />
<module name="JavadocTagContinuationIndentation" /> <module name="JavadocTagContinuationIndentation" />
<module name="SummaryJavadoc"> <module name="SummaryJavadoc">
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/> <property name="forbiddenSummaryFragments"
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )" />
</module> </module>
<module name="JavadocParagraph" /> <module name="JavadocParagraph" />
<module name="AtclauseOrder"> <module name="AtclauseOrder">
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/> <property name="tagOrder"
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/> value="@param, @return, @throws, @deprecated" />
<property name="target"
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" />
</module> </module>
<module name="JavadocMethod"> <module name="JavadocMethod">
<property name="scope" value="public"/> <property name="scope"
<property name="allowMissingParamTags" value="true"/> value="public" />
<property name="allowMissingThrowsTags" value="true"/> <property name="allowMissingParamTags"
<property name="allowMissingReturnTag" value="true"/> value="true" />
<property name="minLineCount" value="2"/> <property name="allowMissingThrowsTags"
value="true" />
<property name="allowMissingReturnTag"
value="true" />
<property name="minLineCount"
value="2" />
<property name="allowedAnnotations" <property name="allowedAnnotations"
value="Override, Test, Before, After, BeforeClass, AfterClass, Parameters" /> value="Override, Test, Before, After, BeforeClass, AfterClass, Parameters" />
<property name="allowUndeclaredRTE" value="true"/> <property name="allowUndeclaredRTE"
<property name="allowThrowsTagsForSubclasses" value="true"/> value="true" />
<property name="suppressLoadErrors" value="true"/> <property name="allowThrowsTagsForSubclasses"
<property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF"/> value="true" />
<property name="suppressLoadErrors"
value="true" />
<property name="tokens"
value="METHOD_DEF, ANNOTATION_FIELD_DEF" />
</module> </module>
<module name="MethodName"> <module name="MethodName">
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/> <property name="format"
value="^[a-z][a-z0-9][a-zA-Z0-9_]*$" />
<message key="name.invalidPattern" <message key="name.invalidPattern"
value="Method name ''{0}'' must match pattern ''{1}''." /> value="Method name ''{0}'' must match pattern ''{1}''." />
</module> </module>
<module name="SingleLineJavadoc"> <module name="SingleLineJavadoc">
<property name="ignoreInlineTags" value="false"/> <property name="ignoreInlineTags"
value="false" />
</module> </module>
<module name="EmptyCatchBlock"> <module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="expected"/> <property name="exceptionVariableName"
value="expected" />
</module> </module>
<module name="CommentsIndentation" /> <module name="CommentsIndentation" />
</module> </module>

15
styleguide/pmd-ruleset.xml
View File

@@ -3,12 +3,14 @@
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0" xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd"> xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 http://pmd.sourceforge.net/ruleset_2_0_0.xsd">
<rule ref="rulesets/java/basic.xml" /> <rule ref="rulesets/java/basic.xml" />
<rule ref="rulesets/java/braces.xml" /> <rule ref="rulesets/java/braces.xml" />
<rule ref="rulesets/java/empty.xml" /> <rule ref="rulesets/java/empty.xml" />
<rule ref="rulesets/java/empty.xml/EmptyCatchBlock"> <rule ref="rulesets/java/empty.xml/EmptyCatchBlock">
<properties> <properties>
<property name="allowCommentedBlocks" value="true"/> <property name="allowCommentedBlocks"
value="true" />
</properties> </properties>
</rule> </rule>
<rule ref="rulesets/java/imports.xml" /> <rule ref="rulesets/java/imports.xml" />
@@ -22,19 +24,17 @@
<rule ref="rulesets/java/unusedcode.xml" /> <rule ref="rulesets/java/unusedcode.xml" />
<rule ref="rulesets/java/unusedcode.xml/UnusedFormalParameter"> <rule ref="rulesets/java/unusedcode.xml/UnusedFormalParameter">
<properties> <properties>
<property name="checkAll" value="true"/> <property name="checkAll"
value="true" />
</properties> </properties>
</rule> </rule>
<!-- Custom Rules --> <!-- Custom Rules -->
<rule name="UseRequireNonNull" <rule name="UseRequireNonNull"
message="Use Objects.requireNonNull() instead of throwing a NullPointerException yourself." message="Use Objects.requireNonNull() instead of throwing a NullPointerException yourself."
language="java" language="java"
class="net.sourceforge.pmd.lang.rule.XPathRule"> class="net.sourceforge.pmd.lang.rule.XPathRule">
<description> <description>Use Objects.requireNonNull() instead of throwing a
Use Objects.requireNonNull() instead of throwing a NullPointerException yourself. NullPointerException yourself.</description>
</description>
<properties> <properties>
<property name="xpath"> <property name="xpath">
<value> <value>
@@ -57,5 +57,4 @@
]]> ]]>
</example> </example>
</rule> </rule>
</ruleset> </ruleset>

11
styleguide/suppressions.xml
View File

@@ -1,9 +1,10 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<!DOCTYPE
<!DOCTYPE suppressions PUBLIC suppressions PUBLIC "-//Puppy Crawl//DTD Suppressions 1.1//EN"
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd"> "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions> <suppressions>
<suppress files=".*sim.*" checks="[a-zA-Z0-9]*"/> <suppress files=".*sim.*"
<suppress files="edu.wpi.first.wpilibj.util.WPILibVersion" checks="[a-zA-Z0-9]*"/> checks="[a-zA-Z0-9]*" />
<suppress files="edu.wpi.first.wpilibj.util.WPILibVersion"
checks="[a-zA-Z0-9]*" />
</suppressions> </suppressions>

3
tidy-html.conf Normal file
View File

@@ -0,0 +1,3 @@
indent: yes
indent-spaces: 2
wrap: 80

4
tidy-xml.conf Normal file
View File

@@ -0,0 +1,4 @@
indent: yes
indent-spaces: 2
indent-attributes: yes
literal-attributes: yes

33
wpilibj/src/main/java/edu/wpi/first/wpilibj/package.html
View File

@@ -1,24 +1,29 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<title>WPI Robotics library</title> <title>
<meta http-equiv="Content-Type" content="text/html; charset=MacRoman"> WPI Robotics library
</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head> </head>
<body> <body>
The WPI Robotics library (WPILibJ) is a set of Java classes that interfaces to the hardware in the The WPI Robotics library (WPILibJ) is a set of Java classes that interfaces
FRC control system and your robot. There are classes to handle sensors, motors, the driver to the hardware in the FRC control system and your robot. There are classes
station, and a number of other utility functions like timing and field management. to handle sensors, motors, the driver station, and a number of other
The library is designed to: utility functions like timing and field management. The library is designed
to:
<ul> <ul>
<li>Deal with all the low level interfacing to these components so you can concentrate on <li>Deal with all the low level interfacing to these components so you
solving this year's "robot problem". This is a philosophical decision to let you focus can concentrate on solving this year's "robot problem". This is a
on the higher-level design of your robot rather than deal with the details of the philosophical decision to let you focus on the higher-level design of
processor and the operating system. your robot rather than deal with the details of the processor and the
operating system.
</li> </li>
<li>Understand everything at all levels by making the full source code of the library <li>Understand everything at all levels by making the full source code of
available. You can study (and modify) the algorithms used by the gyro class for the library available. You can study (and modify) the algorithms used by
oversampling and integration of the input signal or just ask the class for the current the gyro class for oversampling and integration of the input signal or
robot heading. You can work at any level. just ask the class for the current robot heading. You can work at any
level.
</li> </li>
</ul> </ul>
</body> </body>