checkstyle

Contains the implementation of the Checkstyle framework. Developers of plug-ins for Checkstyle should refer to this package to configure and run it.

You should not be referring to this package if you are implementing your own check.

Contains the core API to be used to implement checks. If you want to implement your own check, you should be referring to this package..

Contains the checks that are bundled with the main distribution.

Contains the Block checks that are bundled with the main distribution.

Contains the Coding checks that are bundled with the main distribution.

Contains the Class Design checks that are bundled with the main distribution.

Duplicate code detection tools.

File Header checks.

Contains the Imports checks that are bundled with the main distribution.

Contains all classes required for the indentation check.

Contains J2EE checks.

Contains the Javadoc checks that are bundled with the main distribution.

Contains the Metrics checks that are bundled with the main distribution.

Contains the modifier checks that are bundled with the main distribution.

Contains the Naming conventions checks that are bundled with the main distribution.

Contains the Size Violations checks that are bundled with the main distribution.

Contains the Usage checks that are bundled with the main distribution.

Contains the Whitespace checks that are bundled with the main distribution.

Contains a Check for XPath semantics in a syntac tree.

Contains the doclets used during the build of Checktyle.

You should not be referring to this package.

Contains the filters that are bundled with the main distribution.

Contains the grammar used by the Checkstyle framework.

You should not be referring to this package.

This is definately work in progress. Here are some ideas where you could help:

• Add a read only editor field that highlights the selected AST node.
• Clicking in the editor field could open the corresponding tree path.
• Add a configuration GUI that can be used in all IDE plugins (well, err.., except Eclipse).
• Add ability to execute individual Checks and display the error messages.
• Add a GUI for the {@link com.puppycrawl.tools.checkstyle.api.FileContents}.
• Add ability to define a Check by example (another one of those crazy ideas... :-)