Editing Cs-contrib.unkrig.de

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

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:
<meta name="keywords" content="checkstyle, checks, filters, quickfixes"></meta>
<meta name="description" content="Custom checks, filters and quickfixes for checkstyle and eclipse-cs"></meta>
= 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].
This project uses the [[Cs-doclet|CS doclet]] (internally) to generate its CheckStyle and eclipse-cs metadata files.
Cs-contrib 1.2.21+ requires the CheckStyle core version 8.21+, because there was an (accidential) breaking change in that version.


= 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.


= Documentation =
= Checks and Quickfixes =
 
;[[Cs-contrib.unkrig.de / Checks / de.unkrig.Alignment|<code><de.unkrig.Alignment></code>]]
:Verifies that Java elements are vertically aligned.
 
;[[Cs-contrib.unkrig.de / Checks / de.unkrig.CppCommentAlignment|<code><de.unkrig.CppCommentAlignment></code>]]
:Verifies that C++ comments ('// ...') are correctly aligned.
 
;[[Cs-contrib.unkrig.de / Checks / de.unkrig.InnerAssignment|<code><de.unkrig.InnerAssignment></code>]]
:Verifies that assignments in expressions are parenthesized.
 
;[[Cs-contrib.unkrig.de / Checks / de.unkrig.NameSpelling|<code><de.unkrig.NameSpelling></code>]]
:Verifies that the names of Java elements match, respectively no not match given patterns.
 
;[[Cs-contrib.unkrig.de / Checks / de.unkrig.ParenPad|<code><de.unkrig.ParenPad></code>]]
:Enhanced version of "ParenPad": NOSPACE now allows '<code>( // ...</code>'. <span style="color: red">Superseded by '[[Cs-contrib.unkrig.de / Checks / de.unkrig.Whitespace|de.unkrig.Whitespace]]'.</span>
 
;[[Cs-contrib.unkrig.de / Checks / de.unkrig.Whitespace|<code><de.unkrig.Whitespace></code>]]
:Verifies that tokens are, respectively are not preceded with (and/or followed by) whitespace.
 
;[[Cs-contrib.unkrig.de / Checks / de.unkrig.WhitespaceAround|<code><de.unkrig.WhitespaceAround></code>]]
:Verifies that a token is surrounded by whitespace. <span style="color: red">Superseded by '[[Cs-contrib.unkrig.de / Checks / de.unkrig.Whitespace|de.unkrig.Whitespace]]'.</span>
 
;[[Cs-contrib.unkrig.de / Checks / de.unkrig.WrapAndIndent|<code><de.unkrig.WrapAndIndent></code>]]
:Verifies that statements are uniformly wrapped and indented.


The [http://cs-contrib.unkrig.de/csdoc/ documentation for the cs-contrib checks, filters and quickfixes] was generated by the [http://doclet.unkrig.de CS doclet]
;[[Cs-contrib.unkrig.de / Checks / de.unkrig.ZeroParameterSuperconstructorInvocation|<code><de.unkrig.ZeroParameterSuperconstructorInvocation></code>]]
:Verifies that no constructor calls the zero-parameter superconstructor.
 
= Filters =
 
;[[Cs-contrib.unkrig.de / Filters / de.unkrig.SuppressionLine|<code><de.unkrig.SuppressionLine></code>]]
:Events (i.e. CheckStyle warnings) are switched off by a 'magic line' ('offCommentFormat') or back on by another 'magic line' ('onCommentFormat').


= License =
= License =
Line 29: Line 53:
= Source Code =
= Source Code =


The source code of <code>cs-contrib</code> (the CheckStyle extension) is on GITHUB:
The source code is available through SVN:
 
    https://github.com/aunkrig/cs-contrib/
 
The source code of the Eclipse plugin (<code>.core</code>, <code>.branding</code>, <code>.feature</code>, <code>.updatesite</code>) is also on GITHUB:


     https://github.com/aunkrig/cs-contrib.branding
     https://svn.code.sf.net/p/loggifier/code
    https://github.com/aunkrig/cs-contrib.core
    https://github.com/aunkrig/cs-contrib.core_test
    https://github.com/aunkrig/cs-contrib.feature
    https://github.com/aunkrig/cs-contrib.updatesite
    https://github.com/aunkrig/cs-contrib_dist
Please note that all contributions to unkrig.de may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Unkrig.de:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Retrieved from "https://unkrig.de/w/Cs-contrib.unkrig.de"