Editing Cs-contrib.unkrig.de
Jump to navigation
Jump to search
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
= Introduction = | = Introduction = | ||
This project adds custom checks, filters and quickfixes for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ Eclipse-CS]. | This project adds custom checks, filters and quickfixes for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ Eclipse-CS]. | ||
= Download = | = Download = | ||
Line 19: | Line 13: | ||
A [http://cs-contrib.unkrig.de/CHANGELOG.txt change log] is also available. | A [http://cs-contrib.unkrig.de/CHANGELOG.txt change log] is also available. | ||
= | = Checks and Quickfixes = | ||
;[['de.unkrig.Alignment' check|<code><de.unkrig.Alignment></code>]] | |||
:Verifies that Java elements are vertically aligned. | |||
;[['de.unkrig.CppCommentAlignment' check|<code><de.unkrig.CppCommentAlignment></code>]] | |||
:Verifies that C++ comments ('// ...') are correctly aligned. | |||
;[['de.unkrig.InnerAssignment' check|<code><de.unkrig.InnerAssignment></code>]] | |||
:Verifies that assignments in expressions are parenthesized. | |||
;[['de.unkrig.NameSpelling' check|<code><de.unkrig.NameSpelling></code>]] | |||
:Verifies that the names of Java elements match, respectively no not match given patterns. | |||
;[['de.unkrig.ParenPad' check|<code><de.unkrig.ParenPad></code>]] | |||
:Enhanced version of "ParenPad": NOSPACE now allows '<code>( // ...</code>'. | |||
:<span style="color: red">This check is superseded by '[[#Check 'de.unkrig.Whitespace'|de.unkrig.Whitespace]]'.</span> | |||
;[['de.unkrig.Whitespace' check|<code><de.unkrig.Whitespace></code>]] | |||
:Verifies that tokens are, respectively are not preceded with (and/or followed by) whitespace. | |||
;[['de.unkrig.WhitespaceAround' check|<code><de.unkrig.WHitespaceAround></code>]] | |||
:Verifies that a token is surrounded by whitespace. | |||
== Check 'de.unkrig.WrapAndIndent' == | |||
Statements must be uniformly wrapped and indented. | |||
=== Properties === | |||
;basicOffset :How many spaces to use for new indentation level | |||
=== Quickfixes === | |||
;Wrap line :Wrap this line at the correct position | |||
;Join lines :Append this line to the previous | |||
;Correct indentation :Correct the indentation of this line | |||
== Check 'de.unkrig.ZeroParameterSuperconstructorInvocation' == | |||
Checks that no constructor calls the zero-parameter superconstructor. | |||
'''Quickfixes:''' | |||
;Remove : Remove redundant invocation of zero-parameter superconstructor | |||
= Filters = | |||
== Filter 'de.unkrig.SuppressionLine' == | |||
Events (i.e. CheckStyle warnings) are switched off by a 'magic line' ('offCommentFormat') or back on by another 'magic line' ('onCommentFormat'). | |||
After the 'off' magic line, events do not show if at least one of the following conditions is true: | |||
* The 'checkNameFormat' (if set) is found in the check name (e.g. 'de.unkrig.cscontrib.checks.Alignment') | |||
* The 'messageFormat' (if set) is found in the event message | |||
* The 'moduleIdFormat' (if set) is found in the ID of the module that generated the event | |||
This filter can only work if a 'FileContentsHolder' module exists in the configuration. | |||
'''Properties:''' | |||
;offFormat : Line pattern to trigger filter to begin suppression | |||
;onFormat : Line pattern to trigger filter to end suppression | |||
;checkNameFormat : Check name pattern to suppress | |||
;messageFormat : Message pattern to suppress | |||
;moduleIdFormat : Module ID pattern to suppress | |||
= License = | = License = | ||
Line 29: | Line 78: | ||
= Source Code = | = Source Code = | ||
The source code | The source code is available through SVN: | ||
https:// | https://svn.code.sf.net/p/loggifier/code | ||