Cs-contrib.unkrig.de: Difference between revisions

From unkrig.de
Jump to navigation Jump to search
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
Verifies that C++-style comments ('<code>// ...</code>') are correctly aligned.
<meta name="keywords" content="checkstyle, checks, filters, quickfixes"></meta>
<p>
<meta name="description" content="Custom checks, filters and quickfixes for checkstyle and eclipse-cs"></meta>
C++-style comments must appear on the same column iff
= Introduction =
<ul>
This project adds custom checks, filters and quickfixes for [http://checkstyle.sourceforge.net/ CheckStyle] and [http://eclipse-cs.sourceforge.net/ Eclipse-CS].
  <li>They appear in immediately consecutive lines, and
 
  <li>All of these lines are of the same 'kind' (see below)
This project uses the [[Cs-doclet|CS doclet]] (internally) to generate its CheckStyle and eclipse-cs metadata files.
</ul>
 
Each line of code relates to one of the following 'kinds':
Cs-contrib 1.2.21+ requires the CheckStyle core version 8.21+, because there was an (accidential) breaking change in that version.
<ul>
 
  <li>A line which contains only a C++-style comment
= Download =
  <li>A line which contains only a switch label ('<code>case x:</code>' or '<code>default:</code>') and a C++-style comment
 
  <li>Any other line
Install the ECLIPSE plug-in from this update site:
</ul>
    http://cs-contrib.unkrig.de/update
 
If you're only interested in the checks (and not the ECLIPSE plug-in), you can download the most recent 'de.unkrig.cs-contrib.core_*.jar' file from
    http://cs-contrib.unkrig.de/update/plugins/
and put it on CheckStyle's classpath.
 
A [http://cs-contrib.unkrig.de/CHANGELOG.txt change log] is also available.
 
= Documentation =
 
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]
 
= License =
 
CS-CONTRIB.UNKRIG.DE is published under the "[[New BSD License]]".
 
= Source Code =
 
The source code of <code>cs-contrib</code> (the CheckStyle extension) is on GITHUB:
 
    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://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

Latest revision as of 12:25, 19 January 2022

<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[edit]

This project adds custom checks, filters and quickfixes for CheckStyle and Eclipse-CS.

This project uses the 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[edit]

Install the ECLIPSE plug-in from this update site:

    http://cs-contrib.unkrig.de/update

If you're only interested in the checks (and not the ECLIPSE plug-in), you can download the most recent 'de.unkrig.cs-contrib.core_*.jar' file from

    http://cs-contrib.unkrig.de/update/plugins/

and put it on CheckStyle's classpath.

A change log is also available.

Documentation[edit]

The documentation for the cs-contrib checks, filters and quickfixes was generated by the CS doclet

License[edit]

CS-CONTRIB.UNKRIG.DE is published under the "New BSD License".

Source Code[edit]

The source code of cs-contrib (the CheckStyle extension) is on GITHUB:

   https://github.com/aunkrig/cs-contrib/

The source code of the Eclipse plugin (.core, .branding, .feature, .updatesite) is also on GITHUB:

   https://github.com/aunkrig/cs-contrib.branding
   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