kemitix/kemitix-checkstyle-ruleset
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

AtclauseOrder: adjust order to match that forced by IntelliJ

Browse source
This commit is contained in:
Paul Campbell 2016-09-04 22:34:32 +01:00
parent c24540c17c
commit c1beb073da
2 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -386,17 +386,17 @@ Javadoc `@` clauses must be in the order:
```` ````
/** /**
* *
* @param ...
* @author ... * @author ...
* @version ... * @version ...
* @param ... * @serial ...
* @return ... * @return ...
* @throws ... * @throws ...
* @exception ... * @exception ...
* @serialData ...
* @serialField ...
* @see ... * @see ...
* @since ... * @since ...
* @serial ...
* @serialField ...
* @serialData ...
* @deprecated ... * @deprecated ...
*/ */
```` ````

5
src/main/resources/net/kemitix/checkstyle.xml
View file

@ -29,7 +29,10 @@
<module name="AnnotationUseStyle"/> <!-- annotations should only use () and named attributes when needed --> <module name="AnnotationUseStyle"/> <!-- annotations should only use () and named attributes when needed -->
<module name="AnonInnerLength"/> <!-- limits anonymous inner classes to 20 lines --> <module name="AnonInnerLength"/> <!-- limits anonymous inner classes to 20 lines -->
<module name="ArrayTypeStyle"/> <!-- enforce Java style arrays --> <module name="ArrayTypeStyle"/> <!-- enforce Java style arrays -->
<module name="AtclauseOrder"/> <!-- enforce standard order for javadoc elements --> <module name="AtclauseOrder"> <!-- enforce standard order for javadoc elements - matches IntelliJ's order -->
<property name="tagOrder" value="@param, @author, @version, @serial, @return, @throws, @exception,
@serialData, @serialField, @see, @since, @deprecated"/>
</module>
<module name="AvoidEscapedUnicodeCharacters"> <!-- prevent use of obscure escape codes --> <module name="AvoidEscapedUnicodeCharacters"> <!-- prevent use of obscure escape codes -->
<property name="allowEscapesForControlCharacters" value="true"/> <!-- unless non-printable controls --> <property name="allowEscapesForControlCharacters" value="true"/> <!-- unless non-printable controls -->
</module> </module>